MirOS Manual: XrmEnumerateDatabase(3)


XrmEnumerateDatabase(3X11)XLIB FUNCTIONXrmEnumerateDatabase(3X11)

NAME

     XrmEnumerateDatabase - enumerate resource database entries

SYNTAX

     #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;

XFree86                   Version 4.5.0                         1

XrmEnumerateDatabase(3X11)XLIB FUNCTIONXrmEnumerateDatabase(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 procedure to
     any Xlib function using the same database is not defined.

SEE ALSO

     XrmGetResource(3X11), XrmInitialize(3X11),
     XrmPutResource(3X11)
     Xlib - C Language X Interface

XFree86                   Version 4.5.0                         2

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.