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

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

wSpecifies the window. 

text_prop_return
Returns the XTextProperty structure. 

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 10, 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 Reference Manual