XSetWMName(3X11)    RISC/os Reference Manual     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 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.

DESCRIPTION
     The XSetWMName convenience function performs a XSetTextPro-
     perty on the WM_NAME property (see section 9.1.3).

     The XGetWMName convenience function performs an XGetTextPro-
     perty on the WM_NAME property (see section 9.1.3).

     The XStoreName function assigns the name passed to
     window_name to the specified window.  A window manager can



                         Printed 1/24/91         Release 4 Page 1

XSetWMName(3X11)    RISC/os Reference Manual     XSetWMName(3X11)



     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.

     XStoreName can generate BadAlloc and BadWindow errors.

     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.

     XFetchName can generate a BadWindow error.

PROPERTIES
     WM_NAME   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(3X11), XAllocIconSize(3X11),
     XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11),
     XSetCommand(3X11), XSetTransientForHint(3X11),
     XSetTextProperty(3X11), XSetWMClientMachine(3X11),
     XSetWMColormapWindows(3X11), XSetWMIconName(3X11),
     XSetWMProperties(3X11), XSetWMProtocols(3X11),
     XStringListToTextProperty(3X11)
     Xlib - C Language X Interface


















Release 4 Page 2         Printed 1/24/91