XIconifyWindow

Syntax

Status XIconifyWindow(display, w, screen_number)
      Display *display;
      Window w;
      int screen_number;

Arguments

display Specifies the connection to the X server.
w Specifies the window.
screen_number Specifies the appropriate screen number on the host server.

Description

The XIconifyWindow() function sends a WM_CHANGE_STATE ClientMessage event with a format of 32 and a first data element of IconicState (as described in section 4.1.4 of the Inter-Client Communication Conventions Manual) and a window of w to the root window of the specified screen with an event mask set to SubstructureNotifyMask | SubstructureRedirectMask . Window managers may elect to receive this message and if the window is in its normal state, may treat it as a request to change the window's state from normal to iconic. If the WM_CHANGE_STATE property cannot be interned, XIconifyWindow() does not send a message and returns a zero status. It returns a nonzero status if the client message is sent successfully; otherwise, it returns a zero status.

See also

XChangeWindowAttributes(), XConfigureWindow(), XCreateWindow(), XDestroyWindow(), XMapWindow(), XRaiseWindow(), XReconfigureWMWindow(), XUnmapWindow(), XWithdrawWindow(), "Manipulating Top-Level Windows".
Christophe Tronche, ch@tronche.com