XGetClassHint

Syntax

Status XGetClassHint(display, w, class_hints_return)
      Display *display;
      Window w;
      XClassHint *class_hints_return;

Arguments

display Specifies the connection to the X server.
w Specifies the window.
class_hints_return Returns the XClassHint structure.

Description

The XGetClassHint() function returns the class hint of the specified window to the members of the supplied structure. If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation dependent. It returns a nonzero status on success; otherwise, it returns a zero status. To free res_name and res_class when finished with the strings, use XFree() on each individually.

XGetClassHint() can generate a BadWindow error.

Diagnostics

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

See also

XAllocClassHint(), XAllocIconSize(), XAllocSizeHints(), XAllocWMHints(), XFree(), XSetClassHint(), XSetCommand(), XSetTextProperty(), XSetTransientForHint(), XSetWMClientMachine(), XSetWMColormapWindows(), XSetWMIconName(), XSetWMName(), XSetWMNormalHints(), XSetWMProperties(), XSetWMProtocols(), XSetWMSizeHints(), XStringListToTextProperty(), "Setting and Reading the WM_CLASS Property".
Christophe Tronche, ch.tronche@computer.org