man/XrmEnumerateDatabase.man

   1 '\" t
   2 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining
   5 .\" a copy of this software and associated documentation files (the
   6 .\" "Software"), to deal in the Software without restriction, including
   7 .\" without limitation the rights to use, copy, modify, merge, publish,
   8 .\" distribute, sublicense, and/or sell copies of the Software, and to
   9 .\" permit persons to whom the Software is furnished to do so, subject to
  10 .\" the following conditions:
  11 .\"
  12 .\" The above copyright notice and this permission notice shall be included
  13 .\" in all copies or substantial portions of the Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  19 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  20 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  21 .\" OTHER DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .\" Except as contained in this notice, the name of the X Consortium shall
  24 .\" not be used in advertising or otherwise to promote the sale, use or
  25 .\" other dealings in this Software without prior written authorization
  26 .\" from the X Consortium.
  27 .\"
  28 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  29 .\" Digital Equipment Corporation
  30 .\"
  31 .\" Portions Copyright \(co 1990, 1991 by
  32 .\" Tektronix, Inc.
  33 .\"
  34 .\" Permission to use, copy, modify and distribute this documentation for
  35 .\" any purpose and without fee is hereby granted, provided that the above
  36 .\" copyright notice appears in all copies and that both that copyright notice
  37 .\" and this permission notice appear in all copies, and that the names of
  38 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  39 .\" to this documentation without specific, written prior permission.
  40 .\" Digital and Tektronix makes no representations about the suitability
  41 .\" of this documentation for any purpose.
  42 .\" It is provided ``as is'' without express or implied warranty.
  43 .\"
  44 .\"
  45 .ds xT X Toolkit Intrinsics \- C Language Interface
  46 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  47 .ds xL Xlib \- C Language X Interface
  48 .ds xC Inter-Client Communication Conventions Manual
  49 .na
  50 .de Ds
  51 .nf
  52 .\\$1D \\$2 \\$1
  53 .ft 1
  54 .\".ps \\n(PS
  55 .\".if \\n(VS>=40 .vs \\n(VSu
  56 .\".if \\n(VS<=39 .vs \\n(VSp
  57 ..
  58 .de De
  59 .ce 0
  60 .if \\n(BD .DF
  61 .nr BD 0
  62 .in \\n(OIu
  63 .if \\n(TM .ls 2
  64 .sp \\n(DDu
  65 .fi
  66 ..
  67 .de FD
  68 .LP
  69 .KS
  70 .TA .5i 3i
  71 .ta .5i 3i
  72 .nf
  73 ..
  74 .de FN
  75 .fi
  76 .KE
  77 .LP
  78 ..
  79 .de IN          \" send an index entry to the stderr
  80 ..
  81 .de C{
  82 .KS
  83 .nf
  84 .D
  85 .\"
  86 .\"     choose appropriate monospace font
  87 .\"     the imagen conditional, 480,
  88 .\"     may be changed to L if LB is too
  89 .\"     heavy for your eyes...
  90 .\"
  91 .ie "\\*(.T"480" .ft L
  92 .el .ie "\\*(.T"300" .ft L
  93 .el .ie "\\*(.T"202" .ft PO
  94 .el .ie "\\*(.T"aps" .ft CW
  95 .el .ft R
  96 .ps \\n(PS
  97 .ie \\n(VS>40 .vs \\n(VSu
  98 .el .vs \\n(VSp
  99 ..
 100 .de C}
 101 .DE
 102 .R
 103 ..
 104 .de Pn
 105 .ie t \\$1\fB\^\\$2\^\fR\\$3
 106 .el \\$1\fI\^\\$2\^\fP\\$3
 107 ..
 108 .de ZN
 109 .ie t \fB\^\\$1\^\fR\\$2
 110 .el \fI\^\\$1\^\fP\\$2
 111 ..
 112 .de hN
 113 .ie t <\fB\\$1\fR>\\$2
 114 .el <\fI\\$1\fP>\\$2
 115 ..
 116 .de NT
 117 .ne 7
 118 .ds NO Note
 119 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 120 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 121 .ie n .sp
 122 .el .sp 10p
 123 .TB
 124 .ce
 125 \\*(NO
 126 .ie n .sp
 127 .el .sp 5p
 128 .if '\\$1'C' .ce 99
 129 .if '\\$2'C' .ce 99
 130 .in +5n
 131 .ll -5n
 132 .R
 133 ..
 134 .               \" Note End -- doug kraft 3/85
 135 .de NE
 136 .ce 0
 137 .in -5n
 138 .ll +5n
 139 .ie n .sp
 140 .el .sp 10p
 141 ..
 142 .ny0
 143 '\" t
 144 .TH XrmEnumerateDatabase __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 145 .SH NAME
 146 XrmEnumerateDatabase \- enumerate resource database entries
 147 .SH SYNTAX
 148 .TS
 149 lw(.5i) lw(2i) lw(2.5i).
 150 T{
 151 \&#define
 152 T}      T{
 153 .ZN XrmEnumAllLevels
 154 T}      T{
 155 0
 156 T}
 157 T{
 158 \&#define
 159 T}      T{
 160 .ZN XrmEnumOneLevel
 161 T}      T{
 162 1
 163 T}
 164 .TE
 165 .HP
 166 Bool XrmEnumerateDatabase\^(\^XrmDatabase \fIdatabase\fP\^, XrmNameList
 167 \fIname_prefix\fP\^, XrmClassList \fIclass_prefix\fP\^, int \fImode\fP\^, Bool
 168 (\^*\fIproc\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
 169 .SH ARGUMENTS
 170 .IP \fIdatabase\fP 1i
 171 Specifies the resource database.
 172 .IP \fIname_prefix\fP 1i
 173 Specifies the resource name prefix.
 174 .IP \fIclass_prefix\fP 1i
 175 Specifies the resource class prefix.
 176 .IP \fImode\fP 1i
 177 Specifies the number of levels to enumerate.
 178 .IP \fIproc\fP 1i
 179 Specifies the procedure that is to be called for each matching entry.
 180 .IP \fIarg\fP 1i
 181 Specifies the user-supplied argument that will be passed to the procedure.
 182 .SH DESCRIPTION
 183 The
 184 .ZN XrmEnumerateDatabase
 185 function calls the specified procedure for each resource in the database
 186 that would match some completion of the given name/class resource prefix.
 187 The order in which resources are found is implementation-dependent.
 188 If mode is
 189 .ZN XrmEnumOneLevel ,
 190 a resource must match the given name/class prefix with
 191 just a single name and class appended.  If mode is
 192 .ZN XrmEnumAllLevels ,
 193 the resource must match the given name/class prefix with one or more names and
 194 classes appended.
 195 If the procedure returns
 196 .ZN True ,
 197 the enumeration terminates and the function returns
 198 .ZN True .
 199 If the procedure always returns
 200 .ZN False ,
 201 all matching resources are enumerated and the function returns
 202 .ZN False .
 203 .LP
 204 The procedure is called with the following arguments:
 205 .LP
 206 .\" Start marker code here
 207 .Ds 0
 208 .TA .5i 3i
 209 .ta .5i 3i
 210 (*\fIproc\fP\^)(\^\fIdatabase\fP, \fIbindings\fP, \fIquarks\fP, \fItype\fP, \fIvalue\fP, \fIarg\fP\^)
 211         XrmDatabase *\fIdatabase\fP\^;
 212         XrmBindingList \fIbindings\fP\^;
 213         XrmQuarkList \fIquarks\fP\^;
 214         XrmRepresentation *\fItype\fP\^;
 215         XrmValue *\fIvalue\fP\^;
 216         XPointer \fIarg\fP\^;
 217 .De
 218 .\" End marker code here
 219 .LP
 220 The bindings and quarks lists are terminated by
 221 .ZN NULLQUARK .
 222 Note that pointers
 223 to the database and type are passed, but these values should not be modified.
 224 .LP
 225 The procedure must not modify the database.
 226 If Xlib has been initialized for threads, the procedure is called with
 227 the database locked and the result of a call by the procedure to any
 228 Xlib function using the same database is not defined.
 229 .SH "SEE ALSO"
 230 XrmGetResource(__libmansuffix__),
 231 XrmInitialize(__libmansuffix__),
 232 XrmPutResource(__libmansuffix__)
 233 .br
 234 \fI\*(xL\fP