Manual pages › X Window and screen libraries (3X)

XStName(3X)

set or get window names

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

XStoreName, XFetchName - set or get window names

SYNTAX

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 XWIN server.

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

XStoreName can generate BadAlloc and BadWindow errors.

The XFetchName function returns the name of the specified
window.  If it succeeds, it returns nonzero; otherwise, if
no name has been set for the window, 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.

PROPERTY

     WM_NAME

XWIN 3.0               Last change: 9/1/88                 .ie t

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.