MrmFetchIconLiteral(Xm)        6 January 1993        MrmFetchIconLiteral(Xm)


 Name

    MrmFetchIconLiteral - fetches an icon literal from a hierarchy

 Syntax


    #include <Mrm/MrmPublic.h>

    int MrmFetchIconLiteral(hierarchy_id, index, screen, display, fgpix,
                            bgpix, pixmap)
    MrmHierarchy hierarchy_id;
    String index;
    Screen *screen;
    Display *display;
    Pixel fgpix;
    Pixel bgpix;
    Pixmap *pixmap;


 Description

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

    hierarchyid
            Specifies the ID of the UID hierarchy that contains the specified
            icon literal.  The hierarchyid 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 struc-
            tures, 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.

 Return value

    This function returns one of these status return constants:

    MrmSUCCESS
            The function executed successfully.

    MrmBADHIERARCHY
            The hierarchy ID was invalid.

    MrmNOTFOUND
            The icon literal was not found in the hierarchy.

    MrmWRONGTYPE
            The caller tried to fetch a literal of a type not supported by
            this function.

    MrmFAILURE
            The function failed.

 See also

    MrmFetchBitmapLiteral(Xm), MrmOpenHierarchyPerDisplay(Xm),
    MrmFetchLiteral(Xm), MrmFetchColorLiteral(Xm) and XOpenDisplay(XS).