XGetWMIconName() XGetWMIconName()
Name
XGetWMIconName - read a window's XA_WM_ICON_NAME property.
Synopsis
Status XGetWMIconName(display, w, text_prop_return)
Display *display;
Window w;
XTextProperty *text_prop_return;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
w Specifies the window.
text_prop_return
Returns the XTextProperty structure. This structure should be freed when no longer needed.
Returns
Zero on failure, non-zero on success.
Availability
Release 4 and later.
Description
XGetWMIconName() performs an XGetTextProperty() on the XA_WM_ICON_NAME property of the specified window. XGetWMIconName() supersedes
XGetIconName().
This function is primarily used by window managers to get the name to be written in a window's icon when they need to display that icon.
For more information, see Volume One, Chapter 12, Interclient Communication.
Structures
typedef struct {
unsigned char *value; /* same as Property routines */
Atom encoding; /* prop type */
int format; /* prop data format: 8, 16, or 32 */
unsigned long nitems; /* number of data items in value */
} XTextProperty;
See Also
XGetWMName(), XSetWMIconName(), XSetWMName(), XSetWMProperties().
Xlib - Window Manager Hints XGetWMIconName()
