XSetTextProperty(3X11) MIT X11R4 XSetTextProperty(3X11)
Name
XSetTextProperty, XGetTextProperty - set and read text properties
Syntax
void XSetTextProperty(display, w, text_prop, property)
Display *display;
Window w;
XTextProperty *text_prop;
Atom property;
Status XGetTextProperty(display, w, text_prop_return, property)
Display *display;
Window w;
XTextProperty *text_prop_return;
Atom property;
Arguments
display Specifies the connection to the X server.
property Specifies the property name.
text_prop Specifies the structure to be used.
text_prop_return
Returns the structure.
Description
The function replaces the existing, specified property for the named window with the data, type, format, and number of items determined by
the value field, the encoding field, the format field, and the nitems field, respectively, of the specified structure. If the property
does not already exist, sets it for the specified window.
can generate and errors.
The function reads the specified property from the window and stores the data in the returned structure. It stores the data in the value
field, the type of the data in the encoding field. the format of the data in the format field, and the number of items of data in the
nitems field. The particular interpretation of the property's encoding and data as ``text'' is left to the calling application. If the
specified property does not exist on the window, sets the value field to NULL, the encoding field to None, the format field to 0, and the
nitems field to zero.
If it was able to set these files in the structure, returns a non-zero status; otherwise, it returns a zero status.
can generate and errors.
Properties
WM_CLIENT_MACHINE
The string name of the machine on which the client application is running.
WM_COMMAND
The command and arguments, separated by ASCII nulls, used to invoke the application.
WM_ICON_NAME
Name to be used in icon.
WM_NAME Name of the application.
Diagnostics
The server failed to allocate the requested resource or server memory.
A value for an Atom argument does not name a defined Atom.
Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument
defined as a set of alternatives can generate this error.
A value for a Window argument does not name a defined Window.
See Also
XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XSetCommand(3X11), XSetTransientForHint(3X11),
XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProto-
cols(3X11), XStringListToTextProperty(3X11)
X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys
XSetTextProperty(3X11)
