MrmFetchColorLiteral(Xm)       6 January 1993       MrmFetchColorLiteral(Xm)


 Name

    MrmFetchColorLiteral - fetches a named color literal from a UID file

 Syntax


    #include <Mrm/MrmPublic.h>

    int MrmFetchColorLiteral(hierarchy_id, index, display, colormap_id, pixel)
    MrmHierarchy hierarchy_id;
    String index;
    Display *display;
    Colormap colormap_id;
    Pixel *pixel;


 Description

    The MrmFetchColorLiteral function fetches a named color literal from a
    UID file, and converts the color literal to a pixel color value.

    hierarchyid
            Specifies the ID of the UID hierarchy that contains the specified
            literal.  The hierarchyid was returned in a previous call to
            MrmOpenHierarchyPerDisplay.

    index   Specifies the UIL name of the color literal to fetch.  You must
            define this name in UIL as an exported value.

    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.

    colormapid
            Specifies the ID of the color map.  If NULL, the default color
            map is used.

    pixel   Returns the ID of the color literal.

 Return value

    This function returns one of these status return constants:

    MrmSUCCESS
            The function executed successfully.

    MrmBADHIERARCHY
            The hierarchy ID was invalid.

    MrmNOTFOUND
            The color literal was not found in the UIL file.

    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),
    MrmFetchIconLiteral(Xm), MrmFetchLiteral(Xm) and XOpenDisplay(XS).