Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dwtdrmhgetindexedliteral(3dwt) [ultrix man page]

DwtDrmHGetIndexedLiteral(3Dwt)											    DwtDrmHGetIndexedLiteral(3Dwt)

Name
       DwtDrmHGetIndexedLiteral - Fetches indexed literals from a DRM hierarchy.

Syntax
       Cardinal DwtDrmHGetIndexedLiteral(hierarchy_id, index, context_id)
	    DRMHierarchy hierarchy_id;
	    String index;
	    DRMResourceContextPtr context_id;

Arguments
       hierarchy_id
		 Specifies the hierarchy to be searched.

       index	 Specifies the case-sensitive index of the desired literal.

       context_id
		 Specifies the resource context into which the literal is read.

Description
       The  DwtDrmHGetIndexedLiteral function searches a DRM search hierarchy for a literal, given the literal's index.  That is, it gets a public
       literal from a DRM search hierarchy.  This function returns the literal as the contents of the context buffer.  The group that  is  fetched
       is  always  DRMgLiteral.  The literal type filter is taken from the context.  If unmodified in the context obtained from DwtDrmGetResource-
       Context, there is no filtering (type = RGMtNul).  In general, you do not need to set any of the fields  in  the	context,  except  possibly
       type.   The  following buffer contents are for some common literal types obtained from a UID file.  Note that in some cases the caller must
       cause offsets to be memory pointers.

       DwtDrmRCType(context_id) == RGMrTypeChar8:
	 DwtDrmRCBuffer(context_id) contains a null-terminated ASCII string

       DwtDrmRCType(context_id) == RGMrTypeCString:
	 DwtDrmRCBuffer(context_id) contains a compound-string (DwtCompString)

       DwtDrmRCType(context_id) == RGMrTypeChar8Vector:
       DwtDrmRCType(context_id) == RGMrTypeCStringVector:
	 DwtDrmRCBuffer(context_id) contains an RGM text vector
	 or stringtable (RGMTextVector).  The items in the
	 text vector contain offsets into the buffer that
	 locate either null-terminated ASCII strings or
	 compound-strings.  You can relocate these to memory
	 pointers by adding the buffer address to the offset:
	 item[n].textitem.pointer = item[n].textitem.offset+bufadr

Return Values
       This function returns one of these status return constants:

       DRMSuccess	 The   function   executed
			 successfully.
       DRMNotFound	 Literal not found.
       DRMFailure	 The function failed.
			 Invalid resource context.

														    DwtDrmHGetIndexedLiteral(3Dwt)

Check Out this Related Man Page

DwtFetchSetValues(3Dwt) 												   DwtFetchSetValues(3Dwt)

Name
       DwtFetchSetValues - Fetches the values to be set from literals stored in UID files.

Syntax
       #include <X11/DwtAppl.h>
       Cardinal DwtFetchSetValues(hierarchy_id, widget, args, num_args)
	    DRMHierarchy hierarchy_id;
	    Widget widget;
	    ArgList args;
	    Cardinal num_args;

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

       widget	 Specifies the widget that is modified.

       args	 Specifies an argument list that identifies the widget arguments to be modified as well as the index (UIL  name)  of  the  literal
		 that defines the value for that argument.  The name part of each argument (args[n].name) must begin with the string DwtN followed
		 by the name that uniquely identifies this attribute tag.  For example, DwtNwidth is the attribute name associated with  the  core
		 argument width.  The value part (args[n].value) must be a string that gives the index (UIL name) of the literal.  You must define
		 all literals in UIL as exported values.

       num_args  Specifies the number of entries in args.

Description
       The DwtFetchSetValues function is similar to XtSetValues, except that the values to be set are defined by the UIL  named  values  that  are
       stored in the UID hierarchy.  DwtFetchSetValues fetches the values to be set from literals stored in UID files.

       This  function  sets  the  values on a widget, evaluating the values as public literal resource references resolvable from a UID hierarchy.
       Each literal is fetched from the hierarchy, and its value is modified and converted as required.  This value is then placed in the argument
       list  and used as the actual value for an XtSetValues call.  DwtFetchSetValues allows a widget to be modified after creation using UID file
       values exactly as is done for creation values in DwtFetchWidget.

       As in DwtFetchWidget, each argument whose value can be evaluated from the UID hierarchy is set in the widget.  Values that are not found or
       values in which conversion errors occur are not modified.

       Each  entry  in the argument list identifies an argument to be modified in the widget.  The name part identifies the tag, which begins with
       DwtN.  The value part must be a string whose value is the index of the literal.	Thus, the following code would modify the  label  resource
       of the widget to have the value of the literal accessed by the index OK_button_label in the hierarchy:
       args[n].name = DwtNlabel;
       args[n].value = "OK_button_label";

Return Values
       This function returns one of these status return constants:

       DRMSuccess	 The   function   executed
			 successfully.
       DRMFailure	 The function failed.

See Also
       XtSetValues(3Dwt)

															   DwtFetchSetValues(3Dwt)
Man Page