1XrmEnumerateDatabase(3)         XLIB FUNCTIONS         XrmEnumerateDatabase(3)
2
3
4

NAME

6       XrmEnumerateDatabase - enumerate resource database entries
7

SYNTAX

9       #include <X11/Xresource.h>
10
11              #define   XrmEnumAllLevels       0
12              #define   XrmEnumOneLevel        1
13
14       Bool XrmEnumerateDatabase(XrmDatabase database,  XrmNameList  name_pre‐
15              fix,   XrmClassList  class_prefix,  int  mode,  Bool  (*proc)(),
16              XPointer arg);
17

ARGUMENTS

19       database  Specifies the resource database.
20
21       name_prefix
22                 Specifies the resource name prefix.
23
24       class_prefix
25                 Specifies the resource class prefix.
26
27       mode      Specifies the number of levels to enumerate.
28
29       proc      Specifies the procedure that is to be called for each  match‐
30                 ing entry.
31
32       arg       Specifies  the  user-supplied argument that will be passed to
33                 the procedure.
34

DESCRIPTION

36       The XrmEnumerateDatabase function calls  the  specified  procedure  for
37       each  resource  in the database that would match some completion of the
38       given name/class resource prefix.  The order  in  which  resources  are
39       found  is  implementation-dependent.   If  mode  is  XrmEnumOneLevel, a
40       resource must match the given name/class prefix with just a single name
41       and  class  appended.   If  mode is XrmEnumAllLevels, the resource must
42       match the given name/class prefix with one or more  names  and  classes
43       appended.   If  the  procedure returns True, the enumeration terminates
44       and the function returns True.  If the procedure always returns  False,
45       all matching resources are enumerated and the function returns False.
46
47       The procedure is called with the following arguments:
48
49       (*proc)(database, bindings, quarks, type, value, arg)
50               XrmDatabase *database;
51               XrmBindingList bindings;
52               XrmQuarkList quarks;
53               XrmRepresentation *type;
54               XrmValue *value;
55               XPointer arg;
56
57       The  bindings  and quarks lists are terminated by NULLQUARK.  Note that
58       pointers to the database and type are passed, but these  values  should
59       not be modified.
60
61       The  procedure must not modify the database.  If Xlib has been initial‐
62       ized for threads, the procedure is called with the database locked  and
63       the  result  of  a call by the procedure to any Xlib function using the
64       same database is not defined.
65

SEE ALSO

67       XrmGetResource(3), XrmInitialize(3), XrmPutResource(3)
68       Xlib - C Language X Interface
69
70
71
72X Version 11                     libX11 1.6.9          XrmEnumerateDatabase(3)
Impressum