1XSetWMProtocols(3)              XLIB FUNCTIONS              XSetWMProtocols(3)
2
3
4

NAME

6       XSetWMProtocols,  XGetWMProtocols - set or read a window's WM_PROTOCOLS
7       property
8

SYNTAX

10       Status XSetWMProtocols(Display *display, Window w, Atom *protocols, int
11              count);
12
13       Status XGetWMProtocols(Display *display, Window w, Atom **protocols_re‐
14              turn, int *count_return);
15

ARGUMENTS

17       display   Specifies the connection to the X server.
18
19       count     Specifies the number of protocols in the list.
20
21       count_return
22                 Returns the number of protocols in the list.
23
24       protocols Specifies the list of protocols.
25
26       protocols_return
27                 Returns the list of protocols.
28

DESCRIPTION

30       The XSetWMProtocols function replaces the WM_PROTOCOLS property on  the
31       specified  window with the list of atoms specified by the protocols ar‐
32       gument.  If the property does not already exist,  XSetWMProtocols  sets
33       the  WM_PROTOCOLS property on the specified window to the list of atoms
34       specified by the protocols argument.  The property  is  stored  with  a
35       type  of ATOM and a format of 32.  If it cannot intern the WM_PROTOCOLS
36       atom, XSetWMProtocols returns a zero status.  Otherwise, it  returns  a
37       nonzero status.
38
39       XSetWMProtocols can generate BadAlloc and BadWindow errors.
40
41       The  XGetWMProtocols  function  returns the list of atoms stored in the
42       WM_PROTOCOLS property on the specified window.   These  atoms  describe
43       window  manager  protocols in which the owner of this window is willing
44       to participate.  If the property exists, is of type ATOM, is of  format
45       32, and the atom WM_PROTOCOLS can be interned, XGetWMProtocols sets the
46       protocols_return argument to a list of atoms, sets the count_return ar‐
47       gument  to  the  number  of elements in the list, and returns a nonzero
48       status.  Otherwise, it sets neither of the return arguments and returns
49       a zero status.  To release the list of atoms, use XFree.
50
51       XGetWMProtocols can generate a BadWindow error.
52

PROPERTIES

54       WM_PROTOCOLS
55                 List  of atoms that identify the communications protocols be‐
56                 tween the client and window manager in which  the  client  is
57                 willing to participate.
58

DIAGNOSTICS

60       BadAlloc  The  server  failed  to  allocate  the  requested resource or
61                 server memory.
62
63       BadWindow A value for a Window argument does not name a defined Window.
64

SEE ALSO

66       XAllocClassHint(3),   XAllocIconSize(3),    XAllocSizeHints(3),    XAl‐
67       locWMHints(3), XFree(3), XSetCommand(3), XSetTransientForHint(3), XSet‐
68       TextProperty(3),   XSetWMClientMachine(3),    XSetWMColormapWindows(3),
69       XSetWMIconName(3),  XSetWMName(3),  XSetWMProperties(3), XStringListTo‐
70       TextProperty(3)
71       Xlib - C Language X Interface
72
73
74
75X Version 11                     libX11 1.8.7               XSetWMProtocols(3)
Impressum