xref: /386bsd/usr/X386/man/man3/XSetWMIconName.3x (revision a2142627)
.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0

XSetWMIconName 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
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\^;

$Header: XSetIName.f,v 1.1 88/02/26 10:03:16 mento Exp $
XSetIconName\^(\^display, w\^, icon_name\^)

Display *display\^;

Window w\^;

char *icon_name\^;

$Header: XGetIName.f,v 1.2 88/04/07 14:39:05 mento Exp $
Status XGetIconName\^(\^display, w\^, icon_name_return\^)

Display *display\^;

Window w\^;

char **icon_name_return\^;

ARGUMENTS
$Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
display 1i
Specifies the connection to the X server. $Header: icon_name.a,v 1.2 88/05/17 11:22:33 mento Exp $
icon_name 1i
Specifies the icon name, which should be a null-terminated string. $Header: icon_name1.a,v 1.2 88/05/17 11:24:31 mento Exp $
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. $Header: w.a,v 1.2 88/05/07 11:35:31 mento Exp $
w 1i
Specifies the window.
DESCRIPTION
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 nonzero status on success; otherwise it returns a zero status.

$Header: XSetIName.d,v 1.1 88/02/26 10:50:39 mento Exp $
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.

$Header: XGetIName.d,v 1.4 88/06/11 07:51:07 mento Exp $
The .ZN 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, .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.

PROPERTIES

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

DIAGNOSTICS
$Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $

1i .ZN BadAlloc The server failed to allocate the requested resource or server memory. $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $

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

"SEE ALSO"
XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)

\*(xL