XGetIconSizes

Syntax

Status XGetIconSizes(display, w, size_list_return, count_return)
      Display *display;
      Window w;
      XIconSize **size_list_return;
      int *count_return;

Arguments

display Specifies the connection to the X server.
w Specifies the window.
size_list_return Returns the size list.
count_return Returns the number of items in the size list.

Description

The XGetIconSizes() function returns zero if a window manager has not set icon sizes; otherwise, it return nonzero. XGetIconSizes() should be called by an application that wants to find out what icon sizes would be most appreciated by the window manager under which the application is running. The application should then use XSetWMHints() to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use XFree().

XGetIconSizes() 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(), XSetCommand(), XSetIconSizes()s, XSetTextProperty(), XSetTransientForHint(), XSetWMClientMachine(), XSetWMColormapWindows(), XSetWMIconName(), XSetWMName(), XSetWMProperties(), XSetWMProtocols(), XStringListToTextProperty(), "Setting and Reading the WM_TRANSIENT_FOR Property".
Christophe Tronche, ch.tronche@computer.org