'\" t
.\" FetchIco.sgm /main/11 1996/09/24 15:57:52 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "MrmFetchIconLiteral" 3
.SH "NAME"
\fBMrmFetchIconLiteral\fP \(em Fetches an icon literal from a hierarchy
"MrmFetchIconLiteral"
"uil functions" "MrmFetchIconLiteral"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmFetchIconLiteral\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBString \fBindex\fR\fR,
\fBScreen *\fBscreen\fR\fR,
\fBDisplay *\fBdisplay\fR\fR,
\fBPixel \fBfgpix\fR\fR,
\fBPixel \fBbgpix\fR\fR,
\fBPixmap *\fBpixmap\fR\fR);
.fi
"MRM function" "MrmFetchIconLiteral"
"MrmFetchIconLiteral" "definition"
.SH "DESCRIPTION"
.PP
The
\fBMrmFetchIconLiteral\fP
function
"MrmFetchIconLiteral" "description"
fetches an icon literal from an MRM hierarchy and converts the
icon literal to an X pixmap\&.
.IP "\fIhierarchy_id\fP" 10
Specifies the ID of the UID hierarchy that contains the
specified icon literal\&.
The \fIhierarchy_id\fP was returned in a previous call to
\fBMrmOpenHierarchyPerDisplay\fP\&.
.IP "\fIindex\fP" 10
Specifies the UIL name of the icon literal to fetch\&.
.IP "\fIscreen\fP" 10
Specifies the screen used for the pixmap\&.
The
\fIscreen\fP
argument specifies a pointer to the
Xlib structure
\fBScreen\fR,
which contains the information about that screen and is linked to the
\fBDisplay\fR
structure\&.
For more information on the
\fBDisplay\fR
and
\fBScreen\fR
structures, see the Xlib function
\fBXOpenDisplay\fP
and the associated screen information macros\&.
.IP "\fIdisplay\fP" 10
Specifies the display used for the pixmap\&.
The
\fIdisplay\fP
argument specifies the connection to the X server\&.
For more information on the
\fBDisplay\fR structure, see the Xlib function
\fBXOpenDisplay\fP\&.
.IP "\fIfgpix\fP" 10
Specifies the foreground color for the pixmap\&.
.IP "\fIbgpix\fP" 10
Specifies the background color for the pixmap\&.
.IP "\fIpixmap\fP" 10
Returns the resulting X pixmap value\&.
The function allocates space for this pixmap\&.
The application is responsible for managing the allocated space\&.
The application can recover the allocated space by calling \fBXmDestroyPixmap\fP\&.
.SH "RETURN"
"MrmSUCCESS"
"MrmBAD_HIERARCHY"
"MrmNOT_FOUND"
"MrmFAILURE"
.PP
This function returns one of the following status return constants:
.IP "\fBMrmSUCCESS\fP" 10
The function executed successfully\&.
.IP "\fBMrmBAD_HIERARCHY\fP" 10
The hierarchy ID was invalid\&.
.IP "\fBMrmNOT_FOUND\fP" 10
The icon literal was not found in the hierarchy\&.
.IP "\fBMrmWRONG_TYPE\fP" 10
The caller tried to fetch a literal of a type not supported by this
function\&.
.IP "\fBMrmFAILURE\fP" 10
The function failed\&.
.SH "RELATED"
.PP
\fBMrmFetchBitmapLiteral\fP(3),
\fBMrmOpenHierarchyPerDisplay\fP(3),
\fBMrmFetchLiteral\fP(3),
\fBMrmFetchColorLiteral\fP(3), and
\fBXOpenDisplay\fP(3)\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16