man/XrmPutResource.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XrmPutResource __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XrmPutResource, XrmQPutResource, XrmPutStringResource, XrmQPutStringResource, XrmPutLineResource \- store database resources
 145 .SH SYNTAX
 146 .HP
 147 void XrmPutResource\^(\^XrmDatabase *\fIdatabase\fP\^, char
 148 *\fIspecifier\fP\^, char *\fItype\fP\^, XrmValue *\fIvalue\fP\^);
 149 .HP
 150 void XrmQPutResource\^(\^XrmDatabase *\fIdatabase\fP\^, XrmBindingList
 151 \fIbindings\fP\^, XrmQuarkList \fIquarks\fP\^, XrmRepresentation \fItype\fP\^,
 152 XrmValue *\fIvalue\fP\^);
 153 .HP
 154 void XrmPutStringResource\^(\^XrmDatabase *\fIdatabase\fP\^, char
 155 *\fIspecifier\fP\^, char *\fIvalue\fP\^);
 156 .HP
 157 void XrmQPutStringResource\^(\^XrmDatabase *\fIdatabase\fP\^, XrmBindingList
 158 \fIbindings\fP\^, XrmQuarkList \fIquarks\fP\^, char *\fIvalue\fP\^);
 159 .HP
 160 void XrmPutLineResource\^(\^XrmDatabase *\fIdatabase\fP\^, char
 161 *\fIline\fP\^);
 162 .SH ARGUMENTS
 163 .IP \fIbindings\fP 1i
 164 Specifies a list of bindings.
 165 .IP \fIdatabase\fP 1i
 166 Specifies the resource database.
 167 .IP \fIline\fP 1i
 168 Specifies the resource name and value pair as a single string.
 169 .IP \fIquarks\fP 1i
 170 Specifies the complete or partial name or the class list of the resource.
 171 .IP \fIspecifier\fP 1i
 172 Specifies a complete or partial specification of the resource.
 173 .IP \fItype\fP 1i
 174 Specifies the type of the resource.
 175 .IP \fIvalue\fP 1i
 176 Specifies the value of the resource, which is specified as a string.
 177 .SH DESCRIPTION
 178 If database contains NULL,
 179 .ZN XrmPutResource
 180 creates a new database and returns a pointer to it.
 181 .ZN XrmPutResource
 182 is a convenience function that calls
 183 .ZN XrmStringToBindingQuarkList
 184 followed by:
 185 .LP
 186 .Ds
 187 XrmQPutResource(database, bindings, quarks, XrmStringToQuark(type), value)
 188 .De
 189 .LP
 190 If the specifier and type are not in the Host Portable Character Encoding,
 191 the result is implementation-dependent.
 192 The value is stored in the database without modification.
 193 .LP
 194 If database contains NULL,
 195 .ZN XrmQPutResource
 196 creates a new database and returns a pointer to it.
 197 If a resource entry with the identical bindings and quarks already
 198 exists in the database, the previous type and value are replaced by the new
 199 specified type and value.
 200 The value is stored in the database without modification.
 201 .LP
 202 If database contains NULL,
 203 .ZN XrmPutStringResource
 204 creates a new database and returns a pointer to it.
 205 .ZN XrmPutStringResource
 206 adds a resource with the specified value to the specified database.
 207 .ZN XrmPutStringResource
 208 is a convenience function that first calls
 209 .ZN XrmStringToBindingQuarkList
 210 on the specifier and then calls
 211 .ZN XrmQPutResource ,
 212 using a ``String'' representation type.
 213 If the specifier is not in the Host Portable Character Encoding,
 214 the result is implementation-dependent.
 215 The value is stored in the database without modification.
 216 .LP
 217 If database contains NULL,
 218 .ZN XrmQPutStringResource
 219 creates a new database and returns a pointer to it.
 220 .ZN XrmQPutStringResource
 221 is a convenience routine that constructs an
 222 .ZN XrmValue
 223 for the value string (by calling
 224 .ZN strlen
 225 to compute the size) and
 226 then calls
 227 .ZN XrmQPutResource ,
 228 using a ``String'' representation type.
 229 The value is stored in the database without modification.
 230 .LP
 231 If database contains NULL,
 232 .ZN XrmPutLineResource
 233 creates a new database and returns a pointer to it.
 234 .ZN XrmPutLineResource
 235 adds a single resource entry to the specified database.
 236 The line should be in valid ResourceLine format (see section 15.1)
 237 terminated by a newline or null character;
 238 the database that results from using a string
 239 with incorrect syntax is implementation-dependent.
 240 The string is parsed in the locale of the database.
 241 If the
 242 .ZN ResourceName
 243 is not in the Host Portable Character Encoding,
 244 the result is implementation-dependent.
 245 Note that comment lines are not stored.
 246 .SH "SEE ALSO"
 247 XrmGetResource(__libmansuffix__),
 248 XrmInitialize(__libmansuffix__),
 249 XrmMergeDatabases(__libmansuffix__),
 250 XrmUniqueQuark(__libmansuffix__)
 251 .br
 252 \fI\*(xL\fP