NAME

XGetIconName — get the name to be displayed in an icon. 

SYNOPSIS

Status XGetIconName(display, w, icon_name_return) Display ∗display;  Window w;  char ∗∗icon_name_return;

ARGUMENTS

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

wSpecifies the ID of the window whose icon name you want to learn. 

icon_name_return
Returns a pointer to the name to be displayed in the window’s icon.  The name is a null-terminated string. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding.  Otherwise, the result is implementation-dependent. If a name hasn’t been assigned to the window, XGetIconName() sets this argument to NULL.  When finished with it, a client must free the icon name string using XFree(). 

RETURNS

Zero on failure, non-zero on success. 

DESCRIPTION

XGetIconName() is superseded by XGetWMIconName() in Release 4.  XGetIconName() reads the icon name property of a window.  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.  XGetIconName() returns a non-zero Status if it succeeds, and zero if no icon name has been set for the argument window. 

For more information, see Volume One, Chapter 10, Interclient Communication. 

ERRORS

BadWindow

SEE ALSO

XFetchName(), XGetClassHint(), XGetIconSizes(), XGetNormalHints(), XGetSizeHints(), XGetTransientForHint(), XGetWMHints(), XGetZoomHints(), XSetClassHint(), XSetCommand(), XSetIconName(), XSetIconSizes(), XSetNormalHints(), XSetSizeHints(), XSetTransientForHint(), XSetWMHints(), XSetZoomHints(), XStoreName(). 

Xlib Reference Manual