xref: /386bsd/usr/X386/man/man3/XSetWMProtocols.3x (revision a2142627)
.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0

XSetWMProtocols 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
NAME
XSetWMProtocols, XGetWMProtocols - set or read a window's WM__PROTOCOLS property
SYNTAX
Status XSetWMProtocols\^(\^display, w, protocols, \ count\^)

Display *display\^;

Window w\^;

Atom *protocols\^;

int count\^;

Status XGetWMProtocols\^(\^display, w, protocols_return, \ count_return\^)

Display *display\^;

Window w\^;

Atom **protocols_return\^;

int *count_return\^;

ARGUMENTS
$Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
display 1i
Specifies the connection to the X server.
count 1i
Specifies the number of \*(Cn.
count_return 1i
Returns the number of \*(Cn.
protocols 1i
Specifies the list of protocols.
protocols_return 1i
Returns the list of protocols.
DESCRIPTION
The .ZN XSetWMProtocols function replaces the WM_PROTOCOLS property on the specified window with the list of atoms specified by the protocols argument. If the property does not already exist, .ZN XSetWMProtocols sets the WM_PROTOCOLS property on the specified window to the list of atoms specified by the protocols argument. The property is stored with a type of ATOM and a format of 32. If it cannot intern the WM_PROTOCOLS atom, .ZN XSetWMProtocols returns a zero status. Otherwise, it returns a nonzero status.

.ZN XSetWMProtocols can generate .ZN BadAlloc and .ZN BadWindow errors.

The .ZN XGetWMProtocols function returns the list of atoms stored in the WM_PROTOCOLS property on the specified window. These atoms describe window manager protocols in which the owner of this window is willing to participate. If the property exists, is of type ATOM, is of format 32, and the atom WM_PROTOCOLS can be interned, .ZN XGetWMProtocols sets the protocols_return argument to a list of atoms, sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of atoms, use .ZN XFree .

.ZN XGetWMProtocols can generate a .ZN BadWindow error.

PROPERTIES

1i \s-1WM_PROTOCOLS\s+1 List of atoms that identify the communications protocols between the client and window manager in which the client is willing to participate.

DIAGNOSTICS
$Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $

1i .ZN BadAlloc The server failed to allocate the requested resource or server memory. $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $

1i .ZN BadWindow A value for a Window argument does not name a defined Window.

"SEE ALSO"
XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XStringListToTextProperty(3X11)

\*(xL