MrmFetchBitmapLiteral(Xm)
MrmFetchBitmapLiteral --
fetches a bitmap literal from a hierarchy
Syntax
#include <Mrm/MrmPublic.h>
Cardinal MrmFetchBitmapLiteral(hierarchy_id, index, screen, display,
pixmap_return, width, height)
MrmHierarchy hierarchy_id;
String index;
Screen *screen;
Display *display;
Pixmap *pixmap_return;
Dimension *width;
Dimension *height;
Description
The MrmFetchBitmapLiteral 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.
hierarchy_id-
Specifies the ID of the UID hierarchy that contains the
specified icon literal. The hierarchy_id was returned in
a previous call to MrmOpenHierarchyPerDisplay.
index-
Specifies the UIL name of the bitmap literal to fetch.
screen-
Specifies the screen used for the pixmap.
The screen argument specifies a pointer to the
Xlib structure Screen which contains the information about that
screen and is linked to the Display structure.
For more information on the Display and Screen structures,
see the Xlib function XOpenDisplay and the associated screen
information macros.
display-
Specifies the display used for the pixmap.
The display argument specifies the connection to the X server.
For more information on the Display structure, see the Xlib function
XOpenDisplay.
pixmap_return-
Returns the resulting X pixmap value.
width-
Specifies a pointer to the width of the pixmap.
height-
Specifies a pointer to the height of the pixmap.
Return value
This function returns one of these status return constants:
MrmSUCCESS-
The function executed successfully.
MrmBAD_HIERARCHY-
The hierarchy ID was invalid.
MrmNOT_FOUND-
The bitmap literal was not found in the hierarchy.
MrmWRONG_TYPE-
The caller tried to fetch a literal of a type not supported by this
function.
MrmFAILURE-
The function failed.
See also
MrmFetchIconLiteral(Xm),
MrmFetchLiteral(Xm)
and
XOpenDisplay(XS).
© 2005 Motif Reference (Xm)
SCO OpenServer Release 6.0.0 -- 26 May 2005