Name

DwtFetchLiteral − Fetches a named literal from a UID file. 

Syntax

#include <X11/DwtAppl.h>
int DwtFetchLiteral(hierarchy_id, index, display, value_return, type_return)
     DRMHierarchy hierarchy_id;
     String index;
     Display *display;
     caddr_t *value_return;
     DRMCode *type_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 literal (pixmap) 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. 

value_returnReturns the ID of the named literal’s value. 

type_returnReturns the named literal’s data type. 

Description

The DwtFetchLiteral function reads and returns the value and type of a literal (named value) that is stored as a public resource in a single UID file.  This function returns a pointer to the value of the literal.  For example, an integer is always returned as a pointer to an integer, and a string is always returned as a pointer to a string. 

Applications should not use DwtFetchLiteral for fetching icon or color literals.  If this is attempted, DwtFetchLiteral returns an error. 

Return Values

This function returns one of these status return constants:

See Also

DwtFetchIconLiteral(3Dwt), DwtFetchColorLiteral(3Dwt)