.\" 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.
.\" 
.\" Copyright (c) 1998, 2001 The X Japanese Documentation Project.
.\" 
.\" 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, dis-
.\" tribute, sublicense, and/or sell copies of the Software, and to permit
.\" persons to whom the Software is furnished to do so, subject to the fol-
.\" lowing 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 MERCHANTABIL-
.\" ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
.\" SHALL  THE X JAPANESE DOCUMENTATION PROJECT  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 Japanese
.\" Documentation Project 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 Japanese Documentation Project.
.\" 
.\" X Window System is a trademark of The Open Group.
.\"
.\" Translated Tue Oct 27 00:00:00 JST 1998
.\"         by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\" Updated Mon Oct  8 23:05:53 JST 2001 for XFree86 4.1.0
.\"         by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\"
.\" $XFree86: xc/doc/man/X11/XSeTProp.man,v 1.3 2001/02/09 03:47:46 tsi Exp $
.\"
.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
.ft 1
.\".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 FD
.LP
.KS
.TA .5i 3i
.ta .5i 3i
.nf
..
.de FN
.fi
.KE
.LP
..
.de IN		\" send an index entry to the stderr
..
.de C{
.KS
.nf
.D
.\"
.\"	choose appropriate monospace font
.\"	the imagen conditional, 480,
.\"	may be changed to L if LB is too
.\"	heavy for your eyes...
.\"
.ie "\\*(.T"480" .ft L
.el .ie "\\*(.T"300" .ft L
.el .ie "\\*(.T"202" .ft PO
.el .ie "\\*(.T"aps" .ft CW
.el .ft R
.ps \\n(PS
.ie \\n(VS>40 .vs \\n(VSu
.el .vs \\n(VSp
..
.de C}
.DE
.R
..
.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
..
.de NT
.ne 7
.ds NO Note
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
.ie n .sp
.el .sp 10p
.TB
.ce
\\*(NO
.ie n .sp
.el .sp 5p
.if '\\$1'C' .ce 99
.if '\\$2'C' .ce 99
.in +5n
.ll -5n
.R
..
.		\" Note End -- doug kraft 3/85
.de NE
.ce 0
.in -5n
.ll +5n
.ie n .sp
.el .sp 10p
..
.ny0
.TH XSetTextProperty 3X11 "Release 6.5" "X Version 11" "XLIB FUNCTIONS"
.SH 名前
.\"0 XSetTextProperty, XGetTextProperty \- set and read text properties
XSetTextProperty, XGetTextProperty \- テキストプロパティの設定・取得を行なう
.SH 書式
void XSetTextProperty\^(\^\fIdisplay\fP, \fIw\fP, \fItext_prop\fP,
\fIproperty\fP\^)
.br
      Display *\fIdisplay\fP\^;
.br
      Window \fIw\fP\^;
.br
      XTextProperty *\fItext_prop\fP\^;
.br
      Atom \fIproperty\fP\^;
.LP
Status XGetTextProperty\^(\^\fIdisplay\fP, \fIw\fP, \fItext_prop_return\fP,
\fIproperty\fP\^)
.br
       Display *\fIdisplay\fP\^;
.br
       Window \fIw\fP\^;
.br
       XTextProperty *\fItext_prop_return\fP\^;
.br
       Atom \fIproperty\fP\^;
.SH 引き数
.IP \fIdisplay\fP 1i
.\"0 Specifies the connection to the X server.
X サーバへの接続を指定する。
.\" 原文には w 引き数の説明がないようです。
.IP \fIw\fP 1i
ウィンドウを指定する。
.IP \fIproperty\fP 1i
.\"0 Specifies the property name.
プロパティ名を指定する。
.IP \fItext_prop\fP 1i
.\"0 Specifies the
.\"0 .ZN XTextProperty
.\"0 structure to be used.
使われる
.ZN XTextProperty
構造体を指定する。
.IP \fItext_prop_return\fP 1i
.\"0 Returns the
.\"0 .ZN XTextProperty
.\"0 structure.
.ZN XTextProperty
構造体が返される。
.SH 説明
.\"0 The
.\"0 .ZN XSetTextProperty
.\"0 function replaces the existing specified property for the named window 
.\"0 with the data, type, format, and number of items determined 
.\"0 by the value field, the encoding field, the format field, 
.\"0 and the nitems field, respectively, of the specified
.\"0 .ZN XTextProperty
.\"0 structure.
関数
.ZN XSetTextProperty
は指定されたウィンドウに対して現在指定されているプロパティのデータ、型、
フォーマット、アイテム数を、指定した
.ZN XTextProperty
構造体の value フィールド、encoding フィールド、format フィールド、
nitems フィールドでそれぞれ置き換える。
.\"0 If the property does not already exist,
.\"0 .ZN XSetTextProperty
.\"0 sets it for the specified window.
以前にプロパティが指定されていなければ、
.ZN XSetTextProperty
はプロパティを指定したウィンドウに設定する。
.LP
.\"0 .ZN XSetTextProperty
.\"0 can generate
.\"0 .ZN BadAlloc ,
.\"0 .ZN BadAtom ,
.\"0 .ZN BadValue ,
.\"0 and
.\"0 .ZN BadWindow
.\"0 errors.
.ZN XSetTextProperty
はエラー
.ZN BadAlloc ,
.ZN BadAtom ,
.ZN BadValue ,
.ZN BadWindow
を起こすことがある。
.LP
.\"0 The
.\"0 .ZN XGetTextProperty 
.\"0 function reads the specified property from the window
.\"0 and stores the data in the returned
.\"0 .ZN XTextProperty
.\"0 structure.
関数
.ZN XGetTextProperty 
は指定されたプロパティをウィンドウから取得し、そのデータを
.ZN XTextProperty
構造体に格納して返す。
.\"0 It stores the data in the value field,
.\"0 the type of the data in the encoding field,
.\"0 the format of the data in the format field, 
.\"0 and the number of items of data in the nitems field.
この関数はデータを value フィールドに、データの型を encoding フィール
ドに、データのフォーマットを format フィールドに、データのアイテム数を
nitems フィールドに格納する。
.\"0 An extra byte containing null (which is not included in the nitems member) 
.\"0 is stored at the end of the value field fof text_prop_return.
値が NULL である追加のバイトデータ(これは nitems メンバの数には含まれない)が、
text_prop_return の value フィールドの最後に格納される。
.\"0 The particular interpretation of the property's encoding 
.\"0 and data as text is left to the calling application.
プロパティのエンコーディングの解釈やデータをテキストと解釈することは、
関数を呼び出したアプリケーションの裁量に任される。
.\"0 If the specified property does not exist on the window,
.\"0 .ZN XGetTextProperty
.\"0 sets the value field to NULL, 
.\"0 the encoding field to
.\"0 .ZN None , 
.\"0 the format field to zero, 
.\"0 and the nitems field to zero.
指定されたプロパティをウィンドウが持っていない場合、
.ZN XGetTextProperty
は value フィールドに NULL, encoding フィールドに
.ZN None ,
format フィールドに 0, nitems フィールドに 0 を設定する。
.LP
.\"0 If it was able to read and store the data in the
.\"0 .ZN XTextProperty
.\"0 structure,
.\"0 .ZN XGetTextProperty
.\"0 returns a nonzero status; 
.ZN XTextProperty
構造体のデータの取得や格納ができない場合、
.ZN XGetTextProperty
は 0 でないステータスを返す。
.\"0 otherwise, it returns a zero status.
それ以外の場合はステータスとして 0 が返される。
.LP
.\"0 .ZN XGetTextProperty
.\"0 can generate
.\"0 .ZN BadAtom 
.\"0 and
.\"0 .ZN BadWindow
.\"0 errors.
.ZN XGetTextProperty
はエラー
.ZN BadAtom ,
.ZN BadWindow
を返すことがある。
.SH プロパティ
.TP 1i
\s-1WM_CLIENT_MACHINE\s+1
.\"0 The string name of the machine on which the client application is running.
クライアントアプリケーションが動作しているマシン名を表す文字列。
.TP 1i
\s-1WM_COMMAND\s+1
.\"0 The command and arguments, null-separated, used to invoke the
.\"0 application.
アプリケーションの起動に使われたコマンドと引き数。これは NULL で終わる文
字列である。
.TP 1i
\s-1WM_ICON_NAME\s+1
.\"0 The name to be used in an icon.
アイコンで使われる名前。
.TP 1i
\s-1WM_NAME\s+1
.\"0 The name of the application.
アプリケーションの名前。
.SH 返り値
.TP 1i
.ZN BadAlloc
.\"0 The server failed to allocate the requested resource or server memory.
要求されたリソースやサーバメモリの割り当てにサーバが失敗した。
.TP 1i
.ZN BadAtom
.\"0 A value for an Atom argument does not name a defined Atom.
引き数 Atom の値が、定義されている Atom を示していない。
.TP 1i
.ZN BadValue
.\"0 Some numeric value falls outside the range of values accepted by the request.
.\"0 Unless a specific range is specified for an argument, the full range defined
.\"0 by the argument's type is accepted.  Any argument defined as a set of
.\"0 alternatives can generate this error.
指定された数値に、リクエストの許容範囲を越えているものがある。引き数に対
して特定の範囲が指定されていなければ、引き数の型で定義されている全ての範
囲が許される。選択肢として定義されている引き数はこのエラーを起こすことが
ある。
.TP 1i
.ZN BadWindow
.\"0 A value for a Window argument does not name a defined Window.
引き数 Window に指定された値が、定義された Window を指していない。
.SH 関連項目
XAllocClassHint(3X11),
XAllocIconSize(3X11),
XAllocSizeHints(3X11),
XAllocWMHints(3X11),
XSetCommand(3X11),
XSetTransientForHint(3X11),
XSetWMClientMachine(3X11),
XSetWMColormapWindows(3X11),
XSetWMIconName(3X11),
XSetWMName(3X11),
XSetWMProperties(3X11),
XSetWMProtocols(3X11),
XStringListToTextProperty(3X11)
.br
\fI\*(xL\fP