XrmEnumerateDatabase.man revision 1ab64890
t
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided ``as is'' without express or implied warranty.

$XFree86: xc/doc/man/X11/XEnumDB.man,v 1.4 2003/04/28 22:17:54 herrb Exp $

.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0 t

XrmEnumerateDatabase __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XrmEnumerateDatabase - enumerate resource database entries
SYNTAX
#define
.ZN XrmEnumAllLevels
0
#define
.ZN XrmEnumOneLevel
1

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

ARGUMENTS
database 1i
Specifies the resource database.
name_prefix 1i
Specifies the resource name prefix.
class_prefix 1i
Specifies the resource class prefix.
mode 1i
Specifies the number of levels to enumerate.
proc 1i
Specifies the procedure that is to be called for each matching entry.
arg 1i
Specifies the user-supplied argument that will be passed to the procedure.
DESCRIPTION
The .ZN 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 .ZN XrmEnumOneLevel , a resource must match the given name/class prefix with just a single name and class appended. If mode is .ZN XrmEnumAllLevels , the resource must match the given name/class prefix with one or more names and classes appended. If the procedure returns .ZN True , the enumeration terminates and the function returns .ZN True . If the procedure always returns .ZN False , all matching resources are enumerated and the function returns .ZN False .

The procedure is called with the following arguments:

Start marker code here
.Ds 0 .TA .5i 3i (*proc\^)(\^database, bindings, quarks, type, value, arg\^) XrmDatabase *database\^; XrmBindingList bindings\^; XrmQuarkList quarks\^; XrmRepresentation *type\^; XrmValue *value\^; XPointer arg\^; .De End marker code here

The bindings and quarks lists are terminated by .ZN 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)

\*(xL