2006-11-25 09:33:55 -07:00
|
|
|
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining
|
|
|
|
|
.\" a copy of this software and associated documentation files (the
|
|
|
|
|
.\" "Software"), to deal in the Software without restriction, including
|
|
|
|
|
.\" without limitation the rights to use, copy, modify, merge, publish,
|
|
|
|
|
.\" distribute, sublicense, and/or sell copies of the Software, and to
|
|
|
|
|
.\" permit persons to whom the Software is furnished to do so, subject to
|
|
|
|
|
.\" the following conditions:
|
|
|
|
|
.\"
|
|
|
|
|
.\" The above copyright notice and this permission notice shall be included
|
|
|
|
|
.\" in all copies or substantial portions of the Software.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
|
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
|
|
|
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
|
|
|
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
|
|
|
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
|
|
|
.\" OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Except as contained in this notice, the name of the X Consortium shall
|
|
|
|
|
.\" not be used in advertising or otherwise to promote the sale, use or
|
|
|
|
|
.\" other dealings in this Software without prior written authorization
|
|
|
|
|
.\" from the X Consortium.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
|
|
|
|
|
.\" Digital Equipment Corporation
|
|
|
|
|
.\"
|
|
|
|
|
.\" Portions Copyright \(co 1990, 1991 by
|
|
|
|
|
.\" Tektronix, Inc.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission to use, copy, modify and distribute this documentation for
|
|
|
|
|
.\" any purpose and without fee is hereby granted, provided that the above
|
|
|
|
|
.\" copyright notice appears in all copies and that both that copyright notice
|
|
|
|
|
.\" and this permission notice appear in all copies, and that the names of
|
|
|
|
|
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
|
|
|
|
|
.\" to this documentation without specific, written prior permission.
|
|
|
|
|
.\" Digital and Tektronix makes no representations about the suitability
|
|
|
|
|
.\" of this documentation for any purpose.
|
|
|
|
|
.\" It is provided ``as is'' without express or implied warranty.
|
|
|
|
|
.\"
|
|
|
|
|
.\"
|
|
|
|
|
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
|
|
|
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
|
|
|
.ds xL Xlib \- C Language X Interface
|
|
|
|
|
.ds xC Inter-Client Communication Conventions Manual
|
|
|
|
|
.na
|
|
|
|
|
.de Ds
|
|
|
|
|
.nf
|
|
|
|
|
.\\$1D \\$2 \\$1
|
2013-04-28 10:55:55 -06:00
|
|
|
.ft CW
|
2006-11-25 09:33:55 -07:00
|
|
|
.\".ps \\n(PS
|
|
|
|
|
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
|
|
|
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
|
|
|
..
|
|
|
|
|
.de De
|
|
|
|
|
.ce 0
|
|
|
|
|
.if \\n(BD .DF
|
|
|
|
|
.nr BD 0
|
|
|
|
|
.in \\n(OIu
|
|
|
|
|
.if \\n(TM .ls 2
|
|
|
|
|
.sp \\n(DDu
|
|
|
|
|
.fi
|
|
|
|
|
..
|
|
|
|
|
.de IN \" send an index entry to the stderr
|
|
|
|
|
..
|
|
|
|
|
.de Pn
|
|
|
|
|
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
|
|
|
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
|
|
|
..
|
|
|
|
|
.de ZN
|
|
|
|
|
.ie t \fB\^\\$1\^\fR\\$2
|
|
|
|
|
.el \fI\^\\$1\^\fP\\$2
|
|
|
|
|
..
|
|
|
|
|
.de hN
|
|
|
|
|
.ie t <\fB\\$1\fR>\\$2
|
|
|
|
|
.el <\fI\\$1\fP>\\$2
|
|
|
|
|
..
|
|
|
|
|
.ny0
|
|
|
|
|
.TH XSetTextProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
|
|
|
|
|
.SH NAME
|
|
|
|
|
XSetTextProperty, XGetTextProperty \- set and read text properties
|
|
|
|
|
.SH SYNTAX
|
|
|
|
|
.HP
|
|
|
|
|
void XSetTextProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
|
|
|
|
|
XTextProperty *\fItext_prop\fP\^, Atom \fIproperty\fP\^);
|
|
|
|
|
.HP
|
|
|
|
|
Status XGetTextProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
|
|
|
|
|
XTextProperty *\fItext_prop_return\fP\^, Atom \fIproperty\fP\^);
|
|
|
|
|
.SH ARGUMENTS
|
|
|
|
|
.IP \fIdisplay\fP 1i
|
|
|
|
|
Specifies the connection to the X server.
|
|
|
|
|
.IP \fIproperty\fP 1i
|
|
|
|
|
Specifies the property name.
|
|
|
|
|
.IP \fItext_prop\fP 1i
|
|
|
|
|
Specifies the
|
|
|
|
|
.ZN XTextProperty
|
|
|
|
|
structure to be used.
|
|
|
|
|
.IP \fItext_prop_return\fP 1i
|
|
|
|
|
Returns the
|
|
|
|
|
.ZN XTextProperty
|
|
|
|
|
structure.
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.ZN XSetTextProperty
|
|
|
|
|
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
|
|
|
|
|
.ZN XTextProperty
|
|
|
|
|
structure.
|
|
|
|
|
If the property does not already exist,
|
|
|
|
|
.ZN XSetTextProperty
|
|
|
|
|
sets it for the specified window.
|
|
|
|
|
.LP
|
|
|
|
|
.ZN XSetTextProperty
|
|
|
|
|
can generate
|
|
|
|
|
.ZN BadAlloc ,
|
|
|
|
|
.ZN BadAtom ,
|
|
|
|
|
.ZN BadValue ,
|
|
|
|
|
and
|
|
|
|
|
.ZN BadWindow
|
|
|
|
|
errors.
|
|
|
|
|
.LP
|
|
|
|
|
The
|
|
|
|
|
.ZN XGetTextProperty
|
|
|
|
|
function reads the specified property from the window
|
|
|
|
|
and stores the data in the returned
|
|
|
|
|
.ZN XTextProperty
|
|
|
|
|
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.
|
|
|
|
|
An extra byte containing null (which is not included in the nitems member)
|
|
|
|
|
is stored at the end of the value field of text_prop_return.
|
|
|
|
|
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,
|
|
|
|
|
.ZN XGetTextProperty
|
|
|
|
|
sets the value field to NULL,
|
|
|
|
|
the encoding field to
|
|
|
|
|
.ZN None ,
|
|
|
|
|
the format field to zero,
|
|
|
|
|
and the nitems field to zero.
|
|
|
|
|
.LP
|
|
|
|
|
If it was able to read and store the data in the
|
|
|
|
|
.ZN XTextProperty
|
|
|
|
|
structure,
|
|
|
|
|
.ZN XGetTextProperty
|
|
|
|
|
returns a nonzero status;
|
|
|
|
|
otherwise, it returns a zero status.
|
|
|
|
|
.LP
|
|
|
|
|
.ZN XGetTextProperty
|
|
|
|
|
can generate
|
|
|
|
|
.ZN BadAtom
|
|
|
|
|
and
|
|
|
|
|
.ZN BadWindow
|
|
|
|
|
errors.
|
|
|
|
|
.SH PROPERTIES
|
|
|
|
|
.TP 1i
|
|
|
|
|
\s-1WM_CLIENT_MACHINE\s+1
|
|
|
|
|
The string name of the machine on which the client application is running.
|
|
|
|
|
.TP 1i
|
|
|
|
|
\s-1WM_COMMAND\s+1
|
|
|
|
|
The command and arguments, null-separated, used to invoke the
|
|
|
|
|
application.
|
|
|
|
|
.TP 1i
|
|
|
|
|
\s-1WM_ICON_NAME\s+1
|
|
|
|
|
The name to be used in an icon.
|
|
|
|
|
.TP 1i
|
|
|
|
|
\s-1WM_NAME\s+1
|
|
|
|
|
The name of the application.
|
|
|
|
|
.SH DIAGNOSTICS
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadAlloc
|
|
|
|
|
The server failed to allocate the requested resource or server memory.
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadAtom
|
|
|
|
|
A value for an Atom argument does not name a defined Atom.
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadValue
|
|
|
|
|
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.
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadWindow
|
|
|
|
|
A value for a Window argument does not name a defined Window.
|
|
|
|
|
.SH "SEE ALSO"
|
2010-05-18 13:37:28 -06:00
|
|
|
XAllocClassHint(__libmansuffix__),
|
|
|
|
|
XAllocIconSize(__libmansuffix__),
|
|
|
|
|
XAllocSizeHints(__libmansuffix__),
|
|
|
|
|
XAllocWMHints(__libmansuffix__),
|
|
|
|
|
XSetCommand(__libmansuffix__),
|
|
|
|
|
XSetTransientForHint(__libmansuffix__),
|
|
|
|
|
XSetWMClientMachine(__libmansuffix__),
|
|
|
|
|
XSetWMColormapWindows(__libmansuffix__),
|
|
|
|
|
XSetWMIconName(__libmansuffix__),
|
|
|
|
|
XSetWMName(__libmansuffix__),
|
|
|
|
|
XSetWMProperties(__libmansuffix__),
|
|
|
|
|
XSetWMProtocols(__libmansuffix__),
|
|
|
|
|
XStringListToTextProperty(__libmansuffix__)
|
2006-11-25 09:33:55 -07:00
|
|
|
.br
|
|
|
|
|
\fI\*(xL\fP
|
