XGetWMNormalHints

Syntax

Status XGetWMNormalHints(display, w, hints_return, supplied_return)
      Display *display;
      Window w;
      XSizeHints *hints_return;
      long *supplied_return;

Arguments

display	Specifies the connection to the X server.
w	Specifies the window.
hints_return	Returns the size hints for the window in its normal state.
supplied_return	Returns the hints that were supplied by the user.

Description

The XGetWMNormalHints() function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, XGetWMNormalHints() sets the various fields of the XSizeHints structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status.

If XGetWMNormalHints() returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits:

(USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect)

If the property is large enough to contain the base size and window gravity fields as well, the supplied_return argument will also contain the following bits:

PBaseSize|PWinGravity

XGetWMNormalHints() 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(), XGetWMSizeHints(), XSetCommand(), XSetTextProperty(), XSetTransientForHint(), XSetWMClientMachine(), XSetWMColormapWindows(), XSetWMIconName(), XSetWMName(), XSetWMNormalHints(), XSetWMProperties(), XSetWMProtocols(), XSetWMSizeHints(), XStringListToTextProperty(), "Setting and Reading the WM_NORMAL_HINTS Property".

---

Christophe Tronche, [email protected]