XSetWMName(XS)    X Version 11 (Release 5) 6 January 1993     XSetWMName(XS)


 Name

    XSetWMName - 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.

    textprop      Specifies the XTextProperty structure to be used.

    textpropreturn
                   Returns the XTextProperty structure.

    w              Specifies the window.

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

    windownamereturn
                   Returns the window name, which is a null-terminated
                   string.

 Description

    The XSetWMName convenience function calls XSetTextProperty to set the
    WMNAME property.

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

    The XStoreName function assigns the name passed to windowname 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 win-
    dows 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 nonzero; otherwise, no name has been set for the
    window, and it returns zero.  If the WMNAME property has not been set
    for this window, XFetchName sets windownamereturn 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.  Other-
    wise, 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


    WMNAME        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 Win-
                   dow.

 See also

    XAllocClassHint(XS), XAllocIconSize(XS), XAllocSizeHints(XS),
    XAllocWMHints(XS), XFree(XS), XSetCommand(XS), XSetTransientForHint(XS),
    XSetTextProperty(XS), XSetWMClientMachine(XS), XSetWMColormapWindows(XS),
    XSetWMIconName(XS), XSetWMProperties(XS), XSetWMProtocols(XS),
    XStringListToTextProperty(XS)
    Xlib - C Language X Interface