Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

X11R7.4 - man page for xsetwmiconname (x11r4 section 3)

XSetWMIconName(3)			  XLIB FUNCTIONS			XSetWMIconName(3)

NAME
       XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName - set or read a window's
       WM_ICON_NAME property

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

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

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

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

ARGUMENTS
       display	 Specifies the connection to the X server.

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

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

       text_prop Specifies the XTextProperty structure to be used.

       text_prop_return
		 Returns the XTextProperty structure.

       w	 Specifies the window.

DESCRIPTION
       The XSetWMIconName convenience function calls XSetTextProperty to set the WM_ICON_NAME
       property.

       The XGetWMIconName convenience function calls XGetTextProperty to obtain the WM_ICON_NAME
       property.  It returns a nonzero status on success; otherwise, it returns a zero status.

       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 a nonzero status; 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.  If the data returned by the server is in the Latin Porta-
       ble Character Encoding, then the returned string is in the Host Portable Character Encod-
       ing.  Otherwise, the result is implementation-dependent.  When finished with it, a client
       must free the icon name string using XFree.

       XGetIconName can generate a BadWindow error.

PROPERTIES
       WM_ICON_NAME
		 The name to be used in an 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.

SEE ALSO
       XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11),
       XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11),
       XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMName(3X11), XSetWMProper-
       ties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
       Xlib - C Language X Interface

X Version 11				   libX11 1.2.1 			XSetWMIconName(3)


All times are GMT -4. The time now is 02:44 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password