Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MrmFetchIconLiteral(3)	    Library Functions Manual	  MrmFetchIconLiteral(3)

NAME
     MrmFetchIconLiteral -- Fetches an icon literal from a hierarchy

SYNOPSIS
     #include <Mrm/MrmPublic.h>
     Cardinal MrmFetchIconLiteral(
     MrmHierarchy hierarchy_id,
     const char *index,
     Screen *screen,
     Display *display,
     Pixel fgpix,
     Pixel bgpix,
     Pixmap *pixmap);

DESCRIPTION
     The  MrmFetchIconLiteral function fetches an icon literal from an MRM hier-
     archy and converts the icon literal to an X pixmap.

     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 MrmOpenHierarchyPerDisplay.

     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    Returns	the  resulting	X  pixmap value.  The function allocates
	       space for this pixmap.  The application is responsible for manag-
	       ing the allocated space.  The application can recover  the  allo-
	       cated space by calling XmDestroyPixmap.

RETURN
     This function returns one of the following status return constants:

     MrmSUCCESSThe function executed successfully.

     MrmBAD_HIERARCHY
	       The hierarchy ID was invalid.

     MrmNOT_FOUND
	       The icon literal was not found in the hierarchy.

     MrmWRONG_TYPE
	       The  caller  tried  to fetch a literal of a type not supported by
	       this function.

     MrmFAILUREThe function failed.

RELATED
     MrmFetchBitmapLiteral(3),	  MrmOpenHierarchyPerDisplay(3),    MrmFetchLit-
     eral(3), MrmFetchColorLiteral(3), and XOpenDisplay(3).

							  MrmFetchIconLiteral(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MrmFetchIconLiteral&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help