XSetWMIconName(3X11) — MIT X11R4

Name

XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName − set or read a window’s WM_ICON_NAME property

Syntax

void XSetWMIconName(display, w, text_prop)
   Display *display;
   Window w;
   XTextProperty *text_prop;

Status XGetWMIconName(display, w, text_prop_return)
   Display *display;
   Window w;
   XTextProperty *text_prop_return;

XSetIconName(display, w, icon_name)
   Display *display;
   Window w;
   char *icon_name;

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

Arguments

displaySpecifies the connection to the X server.

icon_nameSpecifies the icon name, which should be a null-terminated string.

icon_name_return
Returns a pointer to the window’s icon name, which is a null-terminated string.

text_propSpecifies the XTextProperty structure to be used.

text_prop_return
Returns the XTextProperty structure.

wSpecifies the window.

Description

The XSetWMIconName convenience function performs a XSetTextProperty on the WM_ICON_NAME property.

The XGetWMIconName convenience function performs an XGetTextProperty on the WM_ICON_NAME property.

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

XSetIconName can generate BadAlloc and BadWindow errors.

The XGetIconName function returns the name to be displayed in the specified window’s icon. If it succeeds, it returns nonzero; otherwise, if no icon name has been set for the window, it returns zero. If you never assigned a name to the window, XGetIconName sets icon_name_return to NULL. When finished with it, a client must free the icon name string using XFree.

XGetIconName can generate a BadWindow error.

Properties

WM_ICON_NAME
Name to be used in icon.

Diagnostics

BadAlloc The server failed to allocate the requested resource or server memory.

BadWindow
A value for a Window argument does not name a defined Window.

Museum

Related Articles