MrmFetchLiteral(3X) SDK X11 R4.11MU05 MrmFetchLiteral(3X)
NAME
MrmFetchLiteral--Fetches a literal from a UID file
SYNOPSIS
#include <Mrm/MrmPublic.h>
int MrmFetchLiteral(hierarchy_id, index, display, value, type)
MrmHierarchyhierarchy_id;
String index;
Display *display;
XtPointer *value;
MrmCode *type;
DESCRIPTION
The MrmFetchLiteral 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 MrmFetchLiteral for fetching icon or
color literals. If this is attempted, MrmFetchLiteral returns an
error.
hierarchy_id
Specifies the ID of the UID hierarchy that contains the
specified literal. The hierarchy_id was returned in a
previous call to MrmOpenHierarchyPerDisplay.
index Specifies the UIL name of the literal (pixmap) 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.
value Returns the ID of the named literal's value.
type Returns the named literal's data type. Types are
defined in the include file <Mrm/MrmPublic.h>.
RETURN VALUE
This function returns one of these status return constants:
MrmSUCCESS The function executed successfully.
MrmBAD_HIERARCHY The hierarchy ID was invalid.
MrmNOT_FOUND The 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.
MrmFAILURE The function failed.
RELATED INFORMATION
MrmFetchBitmapLiteral(3X), MrmOpenHierarchyPerDisplay(3X),
MrmFetchIconLiteral(3X), MrmFetchColorLiteral(3X), and
XOpenDisplay(3X).
Licensed material--property of copyright holder(s)