XGetWMName() XGetWMName()
Name
XGetWMName - read a window's XA_WM_NAME property.
Synopsis
Status XGetWMName(display, w, text_prop_return)
Display *display;
Window w;
XTextProperty *text_prop_return;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
w Specifies the window.
text_prop_return
Returns the XTextProperty structure. This structure should be freed when no longer needed.
Returns
Zero on failure, non-zero on success.
Availability
Release 4 and later.
Description
XGetWMName() performs an XGetTextProperty() on the XA_WM_NAME property of the specified window. XGetWMName() supersedes XFetchName().
XGetWMName() returns non-zero if it succeeds, and zero if the property has not been set for the argument window.
For more information, see Volume One, Chapter 12, Interclient Communication.
Structures
typedef struct {
unsigned char *value; /* same as Property routines */
Atom encoding; /* prop type */
int format; /* prop data format: 8, 16, or 32 */
unsigned long nitems; /* number of data items in value */
} XTextProperty;
See Also
XGetWMIconName(), XSetWMIconName(), XSetWMName(), XSetWMProperties().
Xlib - Window Manager Hints XGetWMName()
Check Out this Related Man Page
XSetWMName(3) XLIB FUNCTIONS XSetWMName(3)NAME
XSetWMName, XGetWMName, XStoreName, XFetchName - set or read a window's WM_NAME property
SYNTAX
void XSetWMName(Display *display, Window w, XTextProperty *text_prop);
Status XGetWMName(Display *display, Window w, XTextProperty *text_prop_return);
int XStoreName(Display *display, Window w, char *window_name);
Status XFetchName(Display *display, Window w, char **window_name_return);
ARGUMENTS
display Specifies the connection to the X server.
text_prop Specifies the XTextProperty structure to be used.
text_prop_return
Returns the XTextProperty structure.
w Specifies the window.
window_name
Specifies the window name, which should be a null-terminated string.
window_name_return
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
WM_NAME The name of the application.
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(3), XAllocIconSize(3), XAllocSizeHints(3), XAllocWMHints(3), XFree(3), XSetCommand(3), XSetTransientForHint(3), XSet-
TextProperty(3), XSetWMClientMachine(3), XSetWMColormapWindows(3), XSetWMIconName(3), XSetWMProperties(3), XSetWMProtocols(3), XStringList-
ToTextProperty(3)
Xlib - C Language X Interface
X Version 11 libX11 1.5.0 XSetWMName(3)