MrmFetchColorLiteral(3X) SDK X11 R4.11MU05 MrmFetchColorLiteral(3X)
NAME
MrmFetchColorLiteral--Fetches a named color literal from a UID file
SYNOPSIS
#include <Mrm/MrmPublic.h>
int MrmFetchColorLiteral(hierarchyid, index, display, colormapid, pixel)
MrmHierarchyhierarchyid;
String index;
Display *display;
Colormap colormapid;
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.
RELATED INFORMATION
MrmFetchBitmapLiteral(3X), MrmOpenHierarchyPerDisplay(3X),
MrmFetchIconLiteral(3X), MrmFetchLiteral(3X), and XOpenDisplay(3X).
Licensed material--property of copyright holder(s)