NAME

       MrmFetchIconLiteral  — Fetches an icon literal from a hierarchy "MrmFetchIconLiteral" "uil
       functions" "MrmFetchIconLiteral"

SYNOPSIS

       #include <Mrm/MrmPublic.h>
       Cardinal MrmFetchIconLiteral(
       MrmHierarchy hierarchy_id,
       String index,
       Screen *screen,
       Display *display,
       Pixel fgpix,
       Pixel bgpix,
       Pixmap *pixmap);
       "MRM function" "MrmFetchIconLiteral" "MrmFetchIconLiteral" "definition"

DESCRIPTION

       The MrmFetchIconLiteral  function  "MrmFetchIconLiteral"  "description"  fetches  an  icon
       literal from an MRM hierarchy and converts the icon literal to an X pixmap.

       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 icon 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.

       fgpix     Specifies the foreground color for the pixmap.

       bgpix     Specifies the background color for the pixmap.

       pixmap    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 XmDestroyPixmap.

RETURN

       "MrmSUCCESS" "MrmBAD_HIERARCHY" "MrmNOT_FOUND" "MrmFAILURE"

       This function returns one of the following status return constants:

       MrmSUCCESS
                 The function executed successfully.

       MrmBAD_HIERARCHY
                 The hierarchy ID was invalid.

       MrmNOT_FOUND
                 The icon 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.

RELATED

       MrmFetchBitmapLiteral(3),        MrmOpenHierarchyPerDisplay(3),        MrmFetchLiteral(3),
       MrmFetchColorLiteral(3), and XOpenDisplay(3).

                                                                           MrmFetchIconLiteral(3)