Man Linux: Main Page and Category List


       MrmFetchLiteral — Fetches a literal from a UID file


       #include <Mrm/MrmPublic.h>
       Cardinal MrmFetchLiteral(
       MrmHierarchy hierarchy_id,
       String index,
       Display *display,
       XtPointer *value,
       MrmCode *type);


       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.

                 Specifies the ID of  the  UID  hierarchy  that  contains  the
                 specified literal.  The value of 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

       value     Returns the ID of the named literal’s  value.   The  function
                 allocates  space  for the returned value.  The application is
                 responsible for managing the allocated space by  calling  the
                 appropriate   deallocation  function.  For  example,  if  the
                 returned ID symbolizes a pixmap,  then  the  application  can
                 recover the allocated space by calling XmDestroyPixmap.

       type      Returns  the named literal’s data type.  Types are defined in
                 the include file Mrm/MrmPublic.h.


       This function returns one of the following status return constants:

                 The function executed successfully.

                 The hierarchy ID was invalid.

                 The literal was not found in the UIL file.

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

                 The function failed.


       MrmFetchBitmapLiteral(3),                MrmOpenHierarchyPerDisplay(3),
       MrmFetchIconLiteral(3), MrmFetchColorLiteral(3), and XOpenDisplay(3).

                                                 MrmFetchLiteral(library call)