1XSetTextProperty(3)             XLIB FUNCTIONS             XSetTextProperty(3)
2
3
4

NAME

6       XSetTextProperty, XGetTextProperty - set and read text properties
7

SYNTAX

9       void   XSetTextProperty(Display   *display,   Window  w,  XTextProperty
10              *text_prop, Atom property);
11
12       Status  XGetTextProperty(Display  *display,  Window  w,   XTextProperty
13              *text_prop_return, Atom property);
14

ARGUMENTS

16       display   Specifies the connection to the X server.
17
18       property  Specifies the property name.
19
20       text_prop Specifies the XTextProperty structure to be used.
21
22       text_prop_return
23                 Returns the XTextProperty structure.
24

DESCRIPTION

26       The  XSetTextProperty function replaces the existing specified property
27       for the named window with the data, type, format, and number  of  items
28       determined  by  the  value field, the encoding field, the format field,
29       and the nitems field,  respectively,  of  the  specified  XTextProperty
30       structure.   If  the  property does not already exist, XSetTextProperty
31       sets it for the specified window.
32
33       XSetTextProperty can generate BadAlloc, BadAtom, BadValue, and  BadWin‐
34       dow errors.
35
36       The  XGetTextProperty  function  reads  the specified property from the
37       window and stores the data in the returned XTextProperty structure.  It
38       stores  the data in the value field, the type of the data in the encod‐
39       ing field, the format of the data in the format field, and  the  number
40       of  items  of  data in the nitems field.  An extra byte containing null
41       (which is not included in the nitems member) is stored at  the  end  of
42       the  value field of text_prop_return.  The particular interpretation of
43       the property's encoding and data as text is left to the calling  appli‐
44       cation.   If the specified property does not exist on the window, XGet‐
45       TextProperty sets the value field to NULL, the encoding field to  None,
46       the format field to zero, and the nitems field to zero.
47
48       If  it  was able to read and store the data in the XTextProperty struc‐
49       ture, XGetTextProperty returns a nonzero status; otherwise, it  returns
50       a zero status.
51
52       XGetTextProperty can generate BadAtom and BadWindow errors.
53

PROPERTIES

55       WM_CLIENT_MACHINE
56                 The  string  name of the machine on which the client applica‐
57                 tion is running.
58
59       WM_COMMAND
60                 The command and arguments, null-separated, used to invoke the
61                 application.
62
63       WM_ICON_NAME
64                 The name to be used in an icon.
65
66       WM_NAME   The name of the application.
67

DIAGNOSTICS

69       BadAlloc  The  server  failed  to  allocate  the  requested resource or
70                 server memory.
71
72       BadAtom   A value for an Atom argument does not name a defined Atom.
73
74       BadValue  Some numeric value falls outside the range of values accepted
75                 by  the request.  Unless a specific range is specified for an
76                 argument, the full range defined by the  argument's  type  is
77                 accepted.   Any argument defined as a set of alternatives can
78                 generate this error.
79
80       BadWindow A value for a Window argument does not name a defined Window.
81

SEE ALSO

83       XAllocClassHint(3),   XAllocIconSize(3),    XAllocSizeHints(3),    XAl‐
84       locWMHints(3), XSetCommand(3), XSetTransientForHint(3), XSetWMClientMa‐
85       chine(3), XSetWMColormapWindows(3),  XSetWMIconName(3),  XSetWMName(3),
86       XSetWMProperties(3), XSetWMProtocols(3), XStringListToTextProperty(3)
87       Xlib - C Language X Interface
88
89
90
91X Version 11                     libX11 1.6.12             XSetTextProperty(3)
Impressum