XIconifyWindow() XIconifyWindow()
Name
XIconifyWindow - request that a top-level window be iconified.
Synopsis
Status XIconifyWindow(display, w, screen_number)
Display *display;
Window w;
int screen_number;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
w Specifies the window.
screen_number
Specifies the appropriate screen number on the server.
Returns
Zero on failure, non-zero on success.
Availability
Release 4 and later.
Description
XIconifyWindow() 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 in Volume Zero, X Protocol Reference Manual), to the root window of the
specified screen. 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 non-zero status if the client message is sent successfully; otherwise, it returns a zero
status.
For more information, see Volume One, Chapter 12, Interclient Communication.
Errors
BadWindow
See Also
XReconfigureWindow, XWithdrawWindow().
Xlib - Window Manager Hints XIconifyWindow()
