Name

XSetIconName, XGetIconName − set or get icon names

Syntax

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.

wSpecifies the window. 

Description

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.

Property

WM_ICON_NAME

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.

See Also

XSetClassHint(3X11), XSetCommand(3X11), XSetIconSizeHints(3X11), XSetNormalHints(3X11), XSetSizeHints(3X11), XSetStandardProperties(3X11), XSetTransientForHint(3X11), XSetWMHints(3X11), XSetZoomHints(3X11), XStoreName(3X11)
Guide to the Xlib Library