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


 Name

    XSetWMColormapWindows - set or read a window's WM_COLORMAP_WINDOWS
    property

 Syntax


    Status XSetWMColormapWindows(display, w, colormap_windows, count)
          Display *display;
          Window w;
          Window *colormap_windows;
          int count;

    Status XGetWMColormapWindows(display, w, colormap_windows_return,
                                 count_return)
          Display *display;
          Window w;
          Window **colormap_windows_return;
          int *count_return;


 Arguments


    display        Specifies the connection to the X server.

    colormapwindows
                   Specifies the list of windows.

    colormapwindowsreturn
                   Returns the list of windows.

    count          Specifies the number of windows in the list.

    countreturn   Returns the number of windows in the list.

    w              Specifies the window.

 Description

    The XSetWMColormapWindows function replaces the WMCOLORMAPWINDOWS pro-
    perty on the specified window with the list of windows specified by the
    colormapwindows argument.  It the property does not already exist,
    XSetWMColormapWindows sets the WMCOLORMAPWINDOWS property on the speci-
    fied window to the list of windows specified by the colormapwindows
    argument.  The property is stored with a type of WINDOW and a format of
    32.  If it cannot intern the WMCOLORMAPWINDOWS atom, XSetWMColormapWin-
    dows returns a zero status.  Otherwise, it returns a nonzero status.

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

    The XGetWMColormapWindows function returns the list of window identifiers
    stored in the WMCOLORMAPWINDOWS property on the specified window.
    These identifiers indicate the colormaps that the window manager may need
    to install for this window.  If the property exists, is of type WINDOW,
    is of format 32, and the atom WMCOLORMAPWINDOWS can be interned,
    XGetWMColormapWindows sets the windowsreturn argument to a list of win-
    dow identifiers, sets the countreturn 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
    window identifiers, use XFree.

    XGetWMColormapWindows can generate a ``BadWindow'' error.

 Properties


    WMCOLORMAPWINDOWS
                   The list of window IDs that may need a different colormap
                   than that of their top-level window.

 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), XSetWMIconName(XS),
    XSetWMName(XS), XSetWMProperties(XS), XSetWMProtocols(XS),
    XStringListToTextProperty(XS)
    Xlib - C Language X Interface