Manual Pages for UNIX Operating System command usage for man XrmEnumerateDatabase

XLIB FUNCTIONS                         XrmEnumerateDatabase(3x11)



NAME
     XrmEnumerateDatabase - enumerate resource database entries

SYNTAX
     cc [ flag... ] file... -lX11 [ library... ]
     #define   XrmEnumAllLevels       0
     #define   XrmEnumOneLevel        1

     Bool XrmEnumerateDatabase(XrmDatabase database, XrmNameList
          name_prefix, XrmClassList class_prefix, int mode, Bool
          (*proc)(), XPointer arg);

ARGUMENTS
     database  Specifies the resource database.

     name_prefix
               Specifies the resource name prefix.

     class_prefix
               Specifies the resource class prefix.

     mode      Specifies the number of levels to enumerate.

     proc      Specifies the procedure that is to be called for
               each matching entry.

     arg       Specifies the user-supplied argument that will be
               passed to the procedure.

DESCRIPTION
     The XrmEnumerateDatabase function calls the specified pro-
     cedure for each resource in the database that would match
     some completion of the given name/class resource prefix.
     The order in which resources are found is implementation-
     dependent.  If mode is XrmEnumOneLevel, a resource must
     match the given name/class prefix with just a single name
     and class appended.  If mode is XrmEnumAllLevels, the
     resource must match the given name/class prefix with one or
     more names and classes appended.  If the procedure returns
     True, the enumeration terminates and the function returns
     True.  If the procedure always returns False, all matching
     resources are enumerated and the function returns False.

     The procedure is called with the following arguments:

     (*proc)(database, bindings, quarks, type, value, arg)
          XrmDatabase *database;
          XrmBindingList bindings;
          XrmQuarkList quarks;
          XrmRepresentation *type;
          XrmValue *value;
          XPointer arg;



X Version 11        Last change: libX11 1.3.5                   1






XLIB FUNCTIONS                         XrmEnumerateDatabase(3x11)



     The bindings and quarks lists are terminated by NULLQUARK.
     Note that pointers to the database and type are passed, but
     these values should not be modified.

     The procedure must not modify the database.  If Xlib has
     been initialized for threads, the procedure is called with
     the database locked and the result of a call by the pro-
     cedure to any Xlib function using the same database is not
     defined.

SEE ALSO
     XrmGetResource(3x11), XrmInitialize(3x11),
     XrmPutResource(3x11)
     Xlib - C Language X Interface


ATTRIBUTES
     See attributes(5) for descriptions of the following attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libx11          |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|


























X Version 11        Last change: libX11 1.3.5                   2