Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xgetwmname(3x11) [ultrix man page]

XSetWMName(3X11)						     MIT X11R4							  XSetWMName(3X11)

Name
       XSetWMName, XGetWMName, XStoreName, XFetchName - set or read a window's WM_NAME property

Syntax
       void XSetWMName(display, w, text_prop)
	  Display *display;
	  Window w;
	  XTextProperty *text_prop;

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

       XStoreName(display, w, window_name)
	  Display *display;
	  Window w;
	  char *window_name;

       Status XFetchName(display, w, window_name_return)
	  Display *display;
	  Window w;
	  char **window_name_return;

Arguments
       display	 Specifies the connection to the X server.

       text_prop Specifies the structure to be used.

       text_prop_return
		 Returns the structure.

       w	 Specifies the window.

       window_name
		 Specifies the window name, which should be a null-terminated string.

       window_name_return
		 Returns a pointer to the window name, which is a null-terminated string.

Description
       The convenience function performs a on the WM_NAME property.

       The convenience function performs an on the WM_NAME property.

       The function assigns the name passed to window_name to the specified window.  A window manager can display the window name in some promi-
       nent place, such as the title bar, to allow users to identify windows easily.  Some window managers may display a window's name in the win-
       dow's icon, although they are encouraged to use the window's icon name if one is provided by the application.

       can generate and errors.

       The function returns the name of the specified window.  If it succeeds, it returns nonzero; otherwise, no name has been set for the window,
       and it returns zero.  If the WM_NAME property has not been set for this window, sets window_name_return to NULL.  When finished with it, a
       client must free the window name string using

       can generate a error.

Properties
       WM_NAME	 Name of the application.

Diagnostics
       The server failed to allocate the requested resource or server memory.

       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), XSetTransient-
       ForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMProper-
       ties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
       X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys

																  XSetWMName(3X11)

Check Out this Related Man Page

XSetWMName(3X11)														  XSetWMName(3X11)

NAME
XSetWMName, XGetWMName, XStoreName, XFetchName - set or read a window's WM_NAME property SYNOPSIS
void XSetWMName(display, w, text_prop) Display *display; Window w; XTextProperty *text_prop; Status XGetWMName(display, w, text_prop_return) Display *display; Window w; XTextProperty *text_prop_return; XStoreName(display, w, window_name) Display *display; Window w; char *window_name; Status XFetchName(display, w, window_name_return) Display *display; Window w; char **window_name_return; ARGUMENTS
Specifies the connection to the X server. Specifies the XTextProperty structure to be used. Returns the XTextProperty structure. Speci- fies the window. Specifies the window name, which should be a null-terminated string. Returns the window name, which is a null-terminated string. DESCRIPTION
The XSetWMName convenience function calls XSetTextProperty to set the WM_NAME property. The XGetWMName convenience function calls XGetTextProperty to obtain the WM_NAME property. It returns a nonzero status on success; other- wise, it returns a zero status. The XStoreName function assigns the name passed to window_name to the specified window. A window manager can display the window name in some prominent place, such as the title bar, to allow users to identify windows easily. Some window managers may display a window's name in the window's icon, although they are encouraged to use the window's icon name if one is provided by the application. If the string is not in the Host Portable Character Encoding, the result is implementation dependent. XStoreName can generate BadAlloc and BadWindow errors. The XFetchName function returns the name of the specified window. If it succeeds, it returns a nonzero status; otherwise, no name has been set for the window, and it returns zero. If the WM_NAME property has not been set for this window, XFetchName sets window_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 window name string using XFree. XFetchName can generate a BadWindow error. PROPERTIES
The name of the application. DIAGNOSTICS
The server failed to allocate the requested resource or server memory. 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), XSetTransient- ForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMProper- ties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11) Xlib -- C Language X Interface XSetWMName(3X11)
Man Page