XGetStandardColormap

This function has been superseded by XGetRGBColormaps().

Syntax

Status XGetStandardColormap(display, w, colormap_return, property)
      Display *display;
      Window w;
      XStandardColormap *colormap_return;
      Atom property;	/* RGB_BEST_MAP, etc. */

Arguments

display	Specifies the connection to the X server.
w	Specifies the window.
colormap_return	Returns the colormap associated with the specified atom.
property	Specifies the property name.

Description

The XGetStandardColormap() function returns the colormap definition associated with the atom supplied as the property argument. XGetStandardColormap() returns a nonzero status if successful and zero otherwise. For example, to fetch the standard GrayScale colormap for a display, you use XGetStandardColormap() with the following syntax:

XGetStandardColormap(dpy, DefaultRootWindow(dpy), &cmap, XA_RGB_GRAY_MAP);

See section "Standard Colormaps" for the semantics of standard colormaps.

XGetStandardColormap() can generate BadAtom and BadWindow errors.

Diagnostics

BadAtom	A value for an Atom argument does not name a defined Atom.
BadWindow	A value for a Window argument does not name a defined Window.

See also

"Compatibility Functions".

---

Christophe Tronche, [email protected]