unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

XrmEnumerateDatabase(3)         XLIB FUNCTIONS         XrmEnumerateDatabase(3)



NAME
       XrmEnumerateDatabase - enumerate resource database entries

SYNTAX
       lw(.5i) lw(2i) lw(2.5i).  T{ #define T}   T{ XrmEnumAllLevels T}   T{ 0
       T} T{ #define T}   T{ XrmEnumOneLevel T}   T{ 1 T}

       Bool XrmEnumerateDatabase(XrmDatabase database, XrmNameList name_pre-
              fix, 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 match-
                 ing entry.

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

DESCRIPTION
       The XrmEnumerateDatabase function calls the specified procedure 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;

       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 initial-
       ized 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



X Version 11                     libX11 1.1.5          XrmEnumerateDatabase(3)