Man page 3 : XSetWMIconName

XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName - set or read a window's WM_ICON_NAME property

void XSetWMIconName(Display *display, Window w, XTextProperty *text_prop); Status XGetWMIconName(Display *display, Window w, XTextProperty *text_prop_return); int XSetIconName(Display *display, Window w, char *icon_name); Status XGetIconName(Display *display, Window w, char **icon_name_return);

display 1i Specifies the connection to the X server.

icon_name 1i Specifies the icon name, which should be a null-terminated string.

icon_name_return 1i Returns the window's icon name, which is a null-terminated string.

text_prop 1i Specifies the .ZN XTextProperty structure to be used.

text_prop_return 1i Returns the .ZN XTextProperty structure.

w 1i Specifies the window.

The .ZN XSetWMIconName convenience function calls .ZN XSetTextProperty to set the WM_ICON_NAME property.

The .ZN XGetWMIconName convenience function calls .ZN XGetTextProperty to obtain the WM_ICON_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status.

The .ZN XSetIconName function sets the name to be displayed in a window's icon.

.ZN XSetIconName can generate .ZN BadAlloc and .ZN BadWindow errors.

The .ZN XGetIconName function returns the name to be displayed in the specified window's icon. If it succeeds, it returns a nonzero status; otherwise, if no icon name has been set for the window, it returns zero. If you never assigned a name to the window, .ZN XGetIconName sets icon_name_return to NULL. 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. When finished with it, a client must free the icon name string using .ZN XFree .

.ZN XGetIconName can generate a .ZN BadWindow error.

• \s-1WM_ICON_NAME\s+1
   The name to be used in an icon.

• .ZN BadAlloc
   The server failed to allocate the requested resource or server memory.
• .ZN BadWindow
   A value for a Window argument does not name a defined Window.

XAllocClassHint(3), XAllocIconSize(3), XAllocSizeHints(3), XAllocWMHints(3), XFree(3), XSetCommand(3), XSetTransientForHint(3), XSetTextProperty(3), XSetWMClientMachine(3), XSetWMColormapWindows(3), XSetWMName(3), XSetWMProperties(3), XSetWMProtocols(3), XStringListToTextProperty(3)
\*(xL