DwtFetchColorLiteral(3Dwt)

Name

DwtFetchColorLiteral − Fetches a named color literal from a UID file.

Syntax

#include <X11/DwtAppl.h>
int DwtFetchColorLiteral(hierarchy_id, index, display, colormap_id, pixel_return)
     DRMHierarchy hierarchy_id;
     String index;
     Display *display;
     Colormap colormap_id;
     Pixel *pixel_return;

Arguments

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

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.

pixel_returnReturns the ID of the color literal.

Description

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

Return Value

This function returns one of these status return constants:

DRMSuccess	The function executed successfully.
DRMNotFound	The color literal was not found in the UIL file.
DRMFailure	The function failed.

Museum