1MrmFetchBitmapLiteral(library call)        MrmFetchBitmapLiteral(library call)
2
3
4

NAME

6       MrmFetchBitmapLiteral — Fetches a bitmap literal from a hierarchy
7

SYNOPSIS

9       #include <Mrm/MrmPublic.h>
10       Cardinal MrmFetchBitmapLiteral(
11       MrmHierarchy hierarchy_id,
12       String index,
13       Screen *screen,
14       Display *display,
15       Pixmap *pixmap_return,
16       Dimension *width,
17       Dimension *height);
18

DESCRIPTION

20       The MrmFetchBitmapLiteral function fetches a bitmap literal from an MRM
21       hierarchy, and converts the bitmap literal to an X pixmap of  depth  1.
22       The function returns this pixmap and its width and height.
23
24       hierarchy_id
25                 Specifies the ID of the UID hierarchy that contains the spec‐
26                 ified icon literal. The value of hierarchy_id was returned in
27                 a previous call to MrmOpenHierarchyPerDisplay.
28
29       index     Specifies the UIL name of the bitmap literal to fetch.
30
31       screen    Specifies  the  screen used for the pixmap.  The screen argu‐
32                 ment specifies a pointer to the Xlib structure  Screen  which
33                 contains  the  information about that screen and is linked to
34                 the Display structure.  For more information on  the  Display
35                 and Screen structures, see the Xlib function XOpenDisplay and
36                 the associated screen information macros.
37
38       display   Specifies the display used for the pixmap.  The display argu‐
39                 ment  specifies  the  connection  to  the X server.  For more
40                 information on the Display structure, see the  Xlib  function
41                 XOpenDisplay.
42
43       pixmap_return
44                 Returns the resulting X pixmap value.  The function allocates
45                 space for this pixmap.  The application  is  responsible  for
46                 managing  the  allocated  space.  The application can recover
47                 the allocated space by calling XmDestroyPixmap.
48
49       width     Specifies a pointer to the width of the pixmap.
50
51       height    Specifies a pointer to the height of the pixmap.
52

RETURN

54       This function returns one of the following status return constants:
55
56       MrmSUCCESS
57                 The function executed successfully.
58
59       MrmBAD_HIERARCHY
60                 The hierarchy ID was invalid.
61
62       MrmNOT_FOUND
63                 The bitmap literal was not found in the hierarchy.
64
65       MrmWRONG_TYPE
66                 The caller tried to fetch a literal of a type  not  supported
67                 by this function.
68
69       MrmFAILURE
70                 The function failed.
71

73       MrmFetchIconLiteral(3), MrmFetchLiteral(3), and XOpenDisplay(3).
74
75
76
77                                           MrmFetchBitmapLiteral(library call)
Impressum