1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
3 .\" Permission is hereby granted, free of charge, to any person obtaining
4 .\" a copy of this software and associated documentation files (the
5 .\" "Software"), to deal in the Software without restriction, including
6 .\" without limitation the rights to use, copy, modify, merge, publish,
7 .\" distribute, sublicense, and/or sell copies of the Software, and to
8 .\" permit persons to whom the Software is furnished to do so, subject to
9 .\" the following conditions:
11 .\" The above copyright notice and this permission notice shall be included
12 .\" in all copies or substantial portions of the Software.
14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 .\" OTHER DEALINGS IN THE SOFTWARE.
22 .\" Except as contained in this notice, the name of the X Consortium shall
23 .\" not be used in advertising or otherwise to promote the sale, use or
24 .\" other dealings in this Software without prior written authorization
25 .\" from the X Consortium.
27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
28 .\" Digital Equipment Corporation
30 .\" Portions Copyright \(co 1990, 1991 by
33 .\" Permission to use, copy, modify and distribute this documentation for
34 .\" any purpose and without fee is hereby granted, provided that the above
35 .\" copyright notice appears in all copies and that both that copyright notice
36 .\" and this permission notice appear in all copies, and that the names of
37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
38 .\" to this documentation without specific, written prior permission.
39 .\" Digital and Tektronix makes no representations about the suitability
40 .\" of this documentation for any purpose.
41 .\" It is provided ``as is'' without express or implied warranty.
44 .ds xT X Toolkit Intrinsics \- C Language Interface
45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
46 .ds xL Xlib \- C Language X Interface
47 .ds xC Inter-Client Communication Conventions Manual
54 .\".if \\n(VS>=40 .vs \\n(VSu
55 .\".if \\n(VS<=39 .vs \\n(VSp
78 .de IN \" send an index entry to the stderr
85 .\" choose appropriate monospace font
86 .\" the imagen conditional, 480,
87 .\" may be changed to L if LB is too
88 .\" heavy for your eyes...
90 .ie "\\*(.T"480" .ft L
91 .el .ie "\\*(.T"300" .ft L
92 .el .ie "\\*(.T"202" .ft PO
93 .el .ie "\\*(.T"aps" .ft CW
96 .ie \\n(VS>40 .vs \\n(VSu
104 .ie t \\$1\fB\^\\$2\^\fR\\$3
105 .el \\$1\fI\^\\$2\^\fP\\$3
108 .ie t \fB\^\\$1\^\fR\\$2
109 .el \fI\^\\$1\^\fP\\$2
112 .ie t <\fB\\$1\fR>\\$2
118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
133 . \" Note End -- doug kraft 3/85
142 .TH XSetWMIconName __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
144 XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName \- set or read a window's WM_ICON_NAME property
147 void XSetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
148 XTextProperty *\fItext_prop\fP\^);
150 Status XGetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
151 XTextProperty *\fItext_prop_return\fP\^);
153 int XSetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char
156 Status XGetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char
157 **\fIicon_name_return\fP\^);
160 Specifies the connection to the X server.
161 .IP \fIicon_name\fP 1i
162 Specifies the icon name,
163 which should be a null-terminated string.
164 .IP \fIicon_name_return\fP 1i
165 Returns the window's icon name,
166 which is a null-terminated string.
167 .IP \fItext_prop\fP 1i
170 structure to be used.
171 .IP \fItext_prop_return\fP 1i
176 Specifies the window.
180 convenience function calls
182 to set the WM_ICON_NAME property.
186 convenience function calls
188 to obtain the WM_ICON_NAME property.
189 It returns a nonzero status on success;
190 otherwise, it returns a zero status.
194 function sets the name to be displayed in a window's icon.
205 function returns the name to be displayed in the specified window's icon.
206 If it succeeds, it returns a nonzero status; otherwise,
207 if no icon name has been set for the window,
209 If you never assigned a name to the window,
211 sets icon_name_return to NULL.
212 If the data returned by the server is in the Latin Portable Character Encoding,
213 then the returned string is in the Host Portable Character Encoding.
214 Otherwise, the result is implementation-dependent.
215 When finished with it, a client must free
216 the icon name string using
226 The name to be used in an icon.
230 The server failed to allocate the requested resource or server memory.
233 A value for a Window argument does not name a defined Window.
235 XAllocClassHint(__libmansuffix__),
236 XAllocIconSize(__libmansuffix__),
237 XAllocSizeHints(__libmansuffix__),
238 XAllocWMHints(__libmansuffix__),
239 XFree(__libmansuffix__),
240 XSetCommand(__libmansuffix__),
241 XSetTransientForHint(__libmansuffix__),
242 XSetTextProperty(__libmansuffix__),
243 XSetWMClientMachine(__libmansuffix__),
244 XSetWMColormapWindows(__libmansuffix__),
245 XSetWMName(__libmansuffix__),
246 XSetWMProperties(__libmansuffix__),
247 XSetWMProtocols(__libmansuffix__),
248 XStringListToTextProperty(__libmansuffix__)