'\" t
...\" FetchBit.sgm /main/10 1996/09/08 21:24:46 rws $
.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 "MrmFetchBitmapLiteral" "library call"
.SH "NAME"
\fBMrmFetchBitmapLiteral\fP \(em Fetches a bitmap literal from a hierarchy
.iX "MrmFetchBitmapLiteral"
.iX "uil functions" "MrmFetchBitmapLiteral"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmFetchBitmapLiteral\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBString \fBindex\fR\fR,
\fBScreen *\fBscreen\fR\fR,
\fBDisplay *\fBdisplay\fR\fR,
\fBPixmap *\fBpixmap_return\fR\fR,
\fBDimension *\fBwidth\fR\fR,
\fBDimension *\fBheight\fR\fR);
.fi
.iX "MRM function" "MrmFetchBitmapLiteral"
.iX "MrmFetchBitmapLiteral" "definition"
.SH "DESCRIPTION"
.iX "MrmFetchBitmapLiteral" "description"
.PP
The \fBMrmFetchBitmapLiteral\fP function fetches a bitmap literal
from an MRM hierarchy, and converts the bitmap literal to an X pixmap
of depth 1\&. The function returns this pixmap and its width and height\&.
.IP "\fIhierarchy_id\fP" 10
Specifies the ID of the UID hierarchy that contains the
specified icon literal\&. The value of \fIhierarchy_id\fP was returned in
a previous call to \fBMrmOpenHierarchyPerDisplay\fP\&.
.IP "\fIindex\fP" 10
Specifies the UIL name of the bitmap 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 "\fIpixmap_return\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\&.
.IP "\fIwidth\fP" 10
Specifies a pointer to the width of the pixmap\&.
.IP "\fIheight\fP" 10
Specifies a pointer to the height of the pixmap\&.
.SH "RETURN"
.iX "MrmSUCCESS"
.iX "MrmBAD_HIERARCHY"
.iX "MrmNOT_FOUND"
.iX "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 bitmap 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
\fBMrmFetchIconLiteral\fP(3),
\fBMrmFetchLiteral\fP(3), and
\fBXOpenDisplay\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16