man/XInternAtom.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 XInternAtom __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames \- create or return atom names
 145 .SH SYNTAX
 146 .HP
 147 Atom XInternAtom\^(\^Display *\fIdisplay\fP\^, char *\fIatom_name\fP\^, Bool
 148 \fIonly_if_exists\fP\^);
 149 .HP
 150 Status XInternAtoms\^(\^Display *\fIdisplay\fP\^, char **\fInames\fP\^, int
 151 \fIcount\fP\^, Bool \fIonly_if_exists\fP\^, Atom *\fIatoms_return\fP\^);
 152 .HP
 153 char *XGetAtomName\^(\^Display *\fIdisplay\fP\^, Atom \fIatom\fP\^);
 154 .HP
 155 Status XGetAtomNames\^(\^Display *\fIdisplay\fP\^, Atom *\fIatoms\fP\^, int
 156 \fIcount\fP\^, char **\fInames_return\fP\^);
 157 .SH ARGUMENTS
 158 .IP \fIatom\fP 1i
 159 Specifies the atom for the property name you want returned.
 160 .IP \fIatoms\fP 1i
 161 Specifies the array of atoms.
 162 .IP \fIatom_name\fP 1i
 163 Specifies the name associated with the atom you want returned.
 164 .IP \fIatoms_return\fP 1i
 165 Returns the atoms.
 166 .ds Cn atom names in the array
 167 .IP \fIcount\fP 1i
 168 Specifies the number of \*(Cn.
 169 .ds Cn atoms in the array
 170 .IP \fIcount\fP 1i
 171 Specifies the number of \*(Cn.
 172 .IP \fIdisplay\fP 1i
 173 Specifies the connection to the X server.
 174 .IP \fInames\fP 1i
 175 Specifies the array of atom names.
 176 .IP \fInames_return\fP 1i
 177 Returns the atom names.
 178 .IP \fIonly_if_exists\fP 1i
 179 Specifies a Boolean value that indicates whether the atom must be created.
 180 .SH DESCRIPTION
 181 The
 182 .ZN XInternAtom
 183 function returns the atom identifier associated with the specified atom_name
 184 string.
 185 If only_if_exists is
 186 .ZN False ,
 187 the atom is created if it does not exist.
 188 Therefore,
 189 .ZN XInternAtom
 190 can return
 191 .ZN None .
 192 If the atom name is not in the Host Portable Character Encoding,
 193 the result is implementation-dependent.
 194 Uppercase and lowercase matter;
 195 the strings ``thing'', ``Thing'', and ``thinG''
 196 all designate different atoms.
 197 The atom will remain defined even after the client's connection closes.
 198 It will become undefined only when the last connection to
 199 the X server closes.
 200 .LP
 201 .ZN XInternAtom
 202 can generate
 203 .ZN BadAlloc
 204 and
 205 .ZN BadValue
 206 errors.
 207 .LP
 208 The
 209 .ZN XInternAtoms
 210 function returns the atom identifiers associated with the specified names.
 211 The atoms are stored in the atoms_return array supplied by the caller.
 212 Calling this function is equivalent to calling
 213 .ZN XInternAtom
 214 for each of the names in turn with the specified value of only_if_exists,
 215 but this function minimizes the number of round-trip protocol exchanges
 216 between the client and the X server.
 217 .LP
 218 This function returns a nonzero status if atoms are returned for
 219 all of the names;
 220 otherwise, it returns zero.
 221 .LP
 222 .ZN XInternAtoms
 223 can generate
 224 .ZN BadAlloc
 225 and
 226 .ZN BadValue
 227 errors.
 228 .LP
 229 The
 230 .ZN XGetAtomName
 231 function returns the name associated with the specified atom.
 232 If the data returned by the server is in the Latin Portable Character Encoding,
 233 then the returned string is in the Host Portable Character Encoding.
 234 Otherwise, the result is implementation-dependent.
 235 To free the resulting string,
 236 call
 237 .ZN XFree .
 238 .LP
 239 .ZN XGetAtomName
 240 can generate a
 241 .ZN BadAtom
 242 error.
 243 .LP
 244 The
 245 .ZN XGetAtomNames
 246 function returns the names associated with the specified atoms.
 247 The names are stored in the names_return array supplied by the caller.
 248 Calling this function is equivalent to calling
 249 .ZN XGetAtomName
 250 for each of the atoms in turn,
 251 but this function minimizes the number of round-trip protocol exchanges
 252 between the client and the X server.
 253 .LP
 254 This function returns a nonzero status if names are returned for
 255 all of the atoms;
 256 otherwise, it returns zero.
 257 .LP
 258 .ZN XGetAtomNames
 259 can generate a
 260 .ZN BadAtom
 261 error.
 262 .SH DIAGNOSTICS
 263 .TP 1i
 264 .ZN BadAlloc
 265 The server failed to allocate the requested resource or server memory.
 266 .TP 1i
 267 .ZN BadAtom
 268 A value for an Atom argument does not name a defined Atom.
 269 .TP 1i
 270 .ZN BadValue
 271 Some numeric value falls outside the range of values accepted by the request.
 272 Unless a specific range is specified for an argument, the full range defined
 273 by the argument's type is accepted.  Any argument defined as a set of
 274 alternatives can generate this error.
 275 .SH "SEE ALSO"
 276 XFree(__libmansuffix__),
 277 XGetWindowProperty(__libmansuffix__)
 278 .br
 279 \fI\*(xL\fP