1XSetWMIconName(3)               XLIB FUNCTIONS               XSetWMIconName(3)
2
3
4

NAME

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

SYNTAX

10       void XSetWMIconName(Display *display, Window w, XTextProperty
11              *text_prop);
12
13       Status XGetWMIconName(Display *display, Window w, XTextProperty
14              *text_prop_return);
15
16       int XSetIconName(Display *display, Window w, char *icon_name);
17
18       Status XGetIconName(Display *display, Window w, char
19              **icon_name_return);
20

ARGUMENTS

22       display   Specifies the connection to the X server.
23
24       icon_name Specifies the icon name, which should be a null-terminated
25                 string.
26
27       icon_name_return
28                 Returns the window's icon name, which is a null-terminated
29                 string.
30
31       text_prop Specifies the XTextProperty structure to be used.
32
33       text_prop_return
34                 Returns the XTextProperty structure.
35
36       w         Specifies the window.
37

DESCRIPTION

39       The XSetWMIconName convenience function calls XSetTextProperty to set
40       the WM_ICON_NAME property.
41
42       The XGetWMIconName convenience function calls XGetTextProperty to
43       obtain the WM_ICON_NAME property.  It returns a nonzero status on suc‐
44       cess; otherwise, it returns a zero status.
45
46       The XSetIconName function sets the name to be displayed in a window's
47       icon.
48
49       XSetIconName can generate BadAlloc and BadWindow errors.
50
51       The XGetIconName function returns the name to be displayed in the spec‐
52       ified window's icon.  If it succeeds, it returns a nonzero status; oth‐
53       erwise, if no icon name has been set for the window, it returns zero.
54       If you never assigned a name to the window, XGetIconName sets
55       icon_name_return to NULL.  If the data returned by the server is in the
56       Latin Portable Character Encoding, then the returned string is in the
57       Host Portable Character Encoding.  Otherwise, the result is implementa‐
58       tion-dependent.  When finished with it, a client must free the icon
59       name string using XFree.
60
61       XGetIconName can generate a BadWindow error.
62

PROPERTIES

64       WM_ICON_NAME
65                 The name to be used in an icon.
66

DIAGNOSTICS

68       BadAlloc  The server failed to allocate the requested resource or
69                 server memory.
70
71       BadWindow A value for a Window argument does not name a defined Window.
72

SEE ALSO

74       XAllocClassHint(3), XAllocIconSize(3), XAllocSizeHints(3), XAl‐
75       locWMHints(3), XFree(3), XSetCommand(3), XSetTransientForHint(3), XSet‐
76       TextProperty(3), XSetWMClientMachine(3), XSetWMColormapWindows(3),
77       XSetWMName(3), XSetWMProperties(3), XSetWMProtocols(3), XStringListTo‐
78       TextProperty(3)
79       Xlib - C Language X Interface
80
81
82
83X Version 11                     libX11 1.6.5                XSetWMIconName(3)
Impressum