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

NAME

6       MrmFetchIconLiteral — Fetches an icon literal from a hierarchy
7

SYNOPSIS

9       #include <Mrm/MrmPublic.h>
10       Cardinal MrmFetchIconLiteral(
11       MrmHierarchy hierarchy_id,
12       String index,
13       Screen *screen,
14       Display *display,
15       Pixel fgpix,
16       Pixel bgpix,
17       Pixmap *pixmap);
18

DESCRIPTION

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

RETURN

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

71       MrmFetchBitmapLiteral(3),  MrmOpenHierarchyPerDisplay(3),  MrmFetchLit‐
72       eral(3), MrmFetchColorLiteral(3), and XOpenDisplay(3).
73
74
75
76                                             MrmFetchIconLiteral(library call)
Impressum