man/XSetWMProtocols.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 XSetWMProtocols __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetWMProtocols, XGetWMProtocols \- set or read a window's WM_PROTOCOLS property
 145 .SH SYNTAX
 146 .HP
 147 Status XSetWMProtocols\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom
 148 *\fIprotocols\fP\^, int \fIcount\fP\^);
 149 .HP
 150 Status XGetWMProtocols\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom
 151 **\fIprotocols_return\fP\^, int *\fIcount_return\fP\^);
 152 .SH ARGUMENTS
 153 .IP \fIdisplay\fP 1i
 154 Specifies the connection to the X server.
 155 .ds Cn protocols in the list
 156 .IP \fIcount\fP 1i
 157 Specifies the number of \*(Cn.
 158 .ds Cn protocols in the list
 159 .IP \fIcount_return\fP 1i
 160 Returns the number of \*(Cn.
 161 .IP \fIprotocols\fP 1i
 162 Specifies the list of protocols.
 163 .IP \fIprotocols_return\fP 1i
 164 Returns the list of protocols.
 165 .SH DESCRIPTION
 166 The
 167 .ZN XSetWMProtocols
 168 function replaces the WM_PROTOCOLS property on the specified window
 169 with the list of atoms specified by the protocols argument.
 170 If the property does not already exist,
 171 .ZN XSetWMProtocols
 172 sets the WM_PROTOCOLS property on the specified window
 173 to the list of atoms specified by the protocols argument.
 174 The property is stored with a type of ATOM and a format of 32.
 175 If it cannot intern the WM_PROTOCOLS atom,
 176 .ZN XSetWMProtocols
 177 returns a zero status.
 178 Otherwise, it returns a nonzero status.
 179 .LP
 180 .ZN XSetWMProtocols
 181 can generate
 182 .ZN BadAlloc
 183 and
 184 .ZN BadWindow
 185 errors.
 186 .LP
 187 The
 188 .ZN XGetWMProtocols
 189 function returns the list of atoms stored in the WM_PROTOCOLS property
 190 on the specified window.
 191 These atoms describe window manager protocols in which the owner
 192 of this window is willing to participate.
 193 If the property exists, is of type ATOM, is of format 32,
 194 and the atom WM_PROTOCOLS can be interned,
 195 .ZN XGetWMProtocols
 196 sets the protocols_return argument to a list of atoms,
 197 sets the count_return argument to the number of elements in the list,
 198 and returns a nonzero status.
 199 Otherwise, it sets neither of the return arguments
 200 and returns a zero status.
 201 To release the list of atoms, use
 202 .ZN XFree .
 203 .LP
 204 .ZN XGetWMProtocols
 205 can generate a
 206 .ZN BadWindow
 207 error.
 208 .SH PROPERTIES
 209 .TP 1i
 210 \s-1WM_PROTOCOLS\s+1
 211 List of atoms that identify the communications protocols between the
 212 client and window manager in which the client is willing to participate.
 213 .SH DIAGNOSTICS
 214 .TP 1i
 215 .ZN BadAlloc
 216 The server failed to allocate the requested resource or server memory.
 217 .TP 1i
 218 .ZN BadWindow
 219 A value for a Window argument does not name a defined Window.
 220 .SH "SEE ALSO"
 221 XAllocClassHint(__libmansuffix__),
 222 XAllocIconSize(__libmansuffix__),
 223 XAllocSizeHints(__libmansuffix__),
 224 XAllocWMHints(__libmansuffix__),
 225 XFree(__libmansuffix__),
 226 XSetCommand(__libmansuffix__),
 227 XSetTransientForHint(__libmansuffix__),
 228 XSetTextProperty(__libmansuffix__),
 229 XSetWMClientMachine(__libmansuffix__),
 230 XSetWMColormapWindows(__libmansuffix__),
 231 XSetWMIconName(__libmansuffix__),
 232 XSetWMName(__libmansuffix__),
 233 XSetWMProperties(__libmansuffix__),
 234 XStringListToTextProperty(__libmansuffix__)
 235 .br
 236 \fI\*(xL\fP