Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dwtfetchiconliteral(3dwt) [ultrix man page]

DwtFetchIconLiteral(3Dwt)												 DwtFetchIconLiteral(3Dwt)

Name
       DwtFetchIconLiteral - Fetches a named icon literal from a hierarchy.

Syntax
       #include <X11/DwtAppl.h>
       int DwtFetchIconLiteral(hierarchy_id, index, screen,
			    display, fgpix, bgpix, pixmap_return)
	    DRMHierarchy hierarchy_id;
	    String index;
	    Screen *screen;
	    Display *display;
	    Pixel fgpix;
	    Pixel bgpix;
	    Pixmap *pixmap_return;

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

       index	 Specifies the UIL name of the icon literal to fetch.

       screen	 Specifies the screen used for the pixmap.  The screen argument specifies a pointer to the Xlib structure  Screen  which  contains
		 the  information about that screen and is linked to the Display structure.  For more information on the Display and Screen struc-
		 tures see the Xlib function XOpenDisplay and the associated screen information macros.

       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.

       fgpix	 Specifies the foreground color for the pixmap.

       bgpix	 Specifies the background color for the pixmap.

       pixmap_return
		 Returns the resulting X pixmap value.

Description
       The DwtFetchIconLiteral function fetches a named icon literal from a DRM hierarchy, and converts the icon literal to an X pixmap.

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

       DRMSuccess	 The   function   executed
			 successfully.
       DRMNotFound	 The icon literal was  not
			 found in the hierarchy.
       DRMFailure	 The function failed.

See Also
       DwtFetchLiteral(3Dwt), DwtFetchColorLiteral(3Dwt)

															 DwtFetchIconLiteral(3Dwt)

Check Out this Related Man Page

DwtFetchLiteral(3Dwt)													     DwtFetchLiteral(3Dwt)

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_id
		 Specifies  the  ID of the UID hierarchy that contains the specified literal.  The hierarchy_id was returned in a previous call to
		 DwtOpenHierarchy.

       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_return
		 Returns the ID of the named literal's value.

       type_return
		 Returns 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 sin-
       gle 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:

       DRMSuccess	 The   function   executed
			 successfully.
       DRMWrongType	 The operation encountered
			 an   unsupported  literal
			 type.
       DRMNotFound	 The literal was not found
			 in the UID file.
       DRMFailure	 The function failed.

See Also
       DwtFetchIconLiteral(3Dwt), DwtFetchColorLiteral(3Dwt)

															     DwtFetchLiteral(3Dwt)
Man Page