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

DwtFetchWidget(3Dwt)													      DwtFetchWidget(3Dwt)

Name
       DwtFetchWidget - Fetches and then creates any indexed (UIL named) application widget and its children.

Syntax
       #include <X11/DwtAppl.h>
       Cardinal DwtFetchWidget(hierarchy_id, index, parent_widget, widget_return, class_return)
	    DRMHierarchy hierarchy_id;
	    String index;
	    Widget parent_widget;
	    Widget *widget_return;
	    DRMType *class_return;

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

       index	 Specifies the UIL name of the widget to fetch.

       parent_widget
		 Specifies the parent widget ID.

       widget_return
		 Returns the widget ID of the created widget.  If this is not NULL when you call DwtFetchWidgetOverride, DRM assumes that the wid-
		 get has already been created and DwtFetchWidgetOverride returns DRMFailure.

       class_return
		 Returns  the class code identifying DRM's widget class.  The widget class code for the main window widget, for example, is DRMwc-
		 MainWindow.  Literals identifying DRM widget class codes are defined in DRM.h.

Description
       The DwtFetchWidget function fetches and then creates an indexed application widget and its children.  The indexed application widget is any
       widget  that is named in UIL and that is not the child of any other widget in the UID hierarchy.  In fetch operations, the fetched widget's
       subtree is also fetched and created.  This widget must not appear as the child of a widget within its own subtree.  DwtFetchWidget does not
       execute XtManageChild for the newly created widget.

       DwtFetchWidget  fetches widgets where DwtFetchInterfaceModule is not used.  DwtFetchWidget provides specific control over which widgets are
       fetched from a UIL file; DwtFetchInterfaceModule, on the other hand, fetches all widgets in a single call.  An application  can	fetch  any
       named widget in the UID hierarchy using DwtFetchWidget.	DwtFetchWidget can be called at any time to fetch a widget that was not fetched at
       application startup.  DwtFetchWidget determines if a widget has already been fetched by checking widget_return for a NULL value.   Non-NULL
       values  signify	that  the  widget already has been fetched, and DwtFetchWidget fails.  DwtFetchWidget can be used to defer fetching pop-up
       widgets until they are first referenced (presumably in a callback), and then used to fetch them once.

       DwtFetchWidget can also create multiple instances of a widget (and its subtree).  In this case, the UID definition functions as a template;
       a  widget  definition can be fetched any number of times.  An application can use this to make multiple instances of a widget, for example,
       in a dialog box box or menu.

       The index (UIL name) that identifies the widget must be known to the application.

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

       DRMSuccess	 The   function   executed
			 successfully.
       DRMNotFound	 Widget  not  found in UID
			 hierarchy.
       DRMFailure	 The function failed.

See Also
       DwtFetchWidgetOverride(3Dwt)

															      DwtFetchWidget(3Dwt)
Man Page