XSetWMColormapWindows, XGetWMColormapWindows - set or read a window's WM_COLORMAP_WINDOWS property


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


display 1i Specifies the connection to the X server.

colormap_windows 1i Specifies the list of windows.

colormap_windows_return 1i Returns the list of windows.

count 1i Specifies the number of \*(Cn.

count_return 1i Returns the number of \*(Cn.

w 1i Specifies the window.


The .ZN XSetWMColormapWindows function replaces the WM_COLORMAP_WINDOWS property on the specified window with the list of windows specified by the colormap_windows argument. It the property does not already exist, .ZN XSetWMColormapWindows sets the WM_COLORMAP_WINDOWS property on the specified window to the list of windows specified by the colormap_windows argument. The property is stored with a type of WINDOW and a format of 32. If it cannot intern the WM_COLORMAP_WINDOWS atom, .ZN XSetWMColormapWindows returns a zero status. Otherwise, it returns a nonzero status.

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

The .ZN XGetWMColormapWindows function returns the list of window identifiers stored in the WM_COLORMAP_WINDOWS 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 WM_COLORMAP_WINDOWS can be interned, .ZN XGetWMColormapWindows sets the windows_return argument to a list of window identifiers, 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 window identifiers, use .ZN XFree .

.ZN XGetWMColormapWindows can generate a .ZN BadWindow error.


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


  • .ZN BadAlloc
     The server failed to allocate the requested resource or server memory.
  • .ZN BadWindow
     A value for a Window argument does not name a defined Window.