XSetWMProtocols(XS)      X Version 11 (Release 5)        XSetWMProtocols(XS)
                                6 January 1993


 Name

    XSetWMProtocols - 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


    display        Specifies the connection to the X server.

    count          Specifies the number of protocols in the list.

    countreturn   Returns the number of protocols in the list.

    protocols      Specifies the list of protocols.

    protocolsreturn
                   Returns the list of protocols.

 Description

    The XSetWMProtocols function replaces the WMPROTOCOLS property on the
    specified window with the list of atoms specified by the protocols argu-
    ment.  If the property does not already exist, XSetWMProtocols sets the
    WMPROTOCOLS property on the specified window to the list of atoms speci-
    fied by the protocols argument.  The property is stored with a type of
    ATOM and a format of 32.  If it cannot intern the WMPROTOCOLS atom,
    XSetWMProtocols returns a zero status.  Otherwise, it returns a nonzero
    status.

    XSetWMProtocols can generate ``BadAlloc'' and ``BadWindow'' errors.

    The XGetWMProtocols function returns the list of atoms stored in the
    WMPROTOCOLS property on the specified window.  These atoms describe win-
    dow 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 WMPROTOCOLS can be interned, XGetWMProtocols sets the
    protocolsreturn argument to a list of atoms, sets the countreturn argu-
    ment 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 XFree.

    XGetWMProtocols can generate a ``BadWindow'' error.

 Properties


    WMPROTOCOLS   List of atoms that identify the communications protocols
                   between the client and window manager in which the client
                   is willing to participate.

 Diagnostics


    ``BadAlloc''   The server failed to allocate the requested resource or
                   server memory.

    ``BadWindow''  A value for a Window argument does not name a defined Win-
                   dow.

 See also

    XAllocClassHint(XS), XAllocIconSize(XS), XAllocSizeHints(XS),
    XAllocWMHints(XS), XFree(XS), XSetCommand(XS), XSetTransientForHint(XS),
    XSetTextProperty(XS), XSetWMClientMachine(XS), XSetWMColormapWindows(XS),
    XSetWMIconName(XS), XSetWMName(XS), XSetWMProperties(XS),
    XStringListToTextProperty(XS)
    Xlib - C Language X Interface