XSetWMName(3X)                                     XSetWMName(3X)



NAME
     XSetWMName, XGetWMName, XStoreName, XFetchName - set and get
     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;

DESCRIPTION
     The XSetWMName convenience function performs a
     XSetTextProperty(3X) on the WM_NAME property (see Section
     9.1.3 in Xlib - C Language Interface).

     The XGetWMName convenience function performs an
     XGetTextProperty(3X) on the WM_NAME property.

     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.

     The XFetchName 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,
     XFetchName sets window-name-return to NULL.  When finished
     with it, a client must free the window name string using
     XFree.

   Arguments
     These functions accept the following arguments:




November, 1990                                                  1

XSetWMName(3X)                                     XSetWMName(3X)



     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 a pointer to the window name, which is a
             null-terminated string.

   Properties
     These functions use the following property:

     WM_NAME Specifies the name of the application.

ERRORS
     BadAlloc
             The server failed to allocate the requested resource
             or server memory.

     BadWindow
             A value for a Window argument does not name a de-
             fined Window.

     The XStoreName function can generate BadAlloc and BadWindow
     errors.

     The XFetchName function can generate a BadWindow error.

SEE ALSO
     XAllocClassHint(3X), XAllocIconSize(3X),
     XAllocSizeHints(3X), XAllocWMHints(3X), XFree(3X),
     XSetCommand(3X), XSetTransientForHint(3X),
     XSetTextProperty(3X), XSetWMClientMachine(3X),
     XSetWMColormapWindows(3X), XSetWMIconName(3X),
     XSetWMProperties(3X), XSetWMProtocols(3X),
     XStringListToTextProperty(3X)

     Xlib - C Language Interface









2                                                  November, 1990