OSF/Motif

NAME

MrmFetchColorLiteral − Fetches a named color literal from a UID file

SYNOPSIS

#include <Mrm/MrmPublic.h>
int MrmFetchColorLiteral(hierarchy_id, index, display,
                         colormap_id, pixel)
MrmHierarchy hierarchy_id;
Stringindex;
Display∗display;
Colormapcolormap_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. 

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

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

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

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

pixelReturns the ID of the color literal. 

RETURN VALUE

This function returns one of these status return constants:

MrmSUCCESSThe function executed successfully. 

MrmBAD_HIERARCHY
The hierarchy ID was invalid.

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

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

MrmFAILUREThe function failed. 

RELATED INFORMATION

MrmFetchBitmapLiteral(3X), MrmOpenHierarchyPerDisplay(3X), MrmFetchIconLiteral(3X), MrmFetchLiteral(3X), and XOpenDisplay(3X11).