XSetTextProperty
Section: XLIB FUNCTIONS (3X11)
Updated: Release 6.3
Index
xjman/web INDEX
名前
XSetTextProperty, XGetTextProperty - テキストプロパティの設定と取得
書式
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;
引き数
- display
-
X サーバへの接続を指定する。
- w
-
ウィンドウを指定する。
- property
-
プロパティ名を指定する。
- text_prop
-
使われる
XTextProperty
構造体を指定する。
- text_prop_return
-
XTextProperty
構造体が返される。
説明
関数
XSetTextProperty
は指定されたウィンドウに対して現在指定されているプロパティのデータ、型、
フォーマット、アイテム数を、指定した
XTextProperty
構造体の value フィールド、encoding フィールド、format フィールド、
nitems フィールドでそれぞれ置き換える。
以前にプロパティが指定されていなければ、
XSetTextProperty
はプロパティを指定したウィンドウに設定する。
XSetTextProperty
はエラー
BadAlloc,
BadAtom,
BadValue,
BadWindow
を起こすことがある。
関数
XGetTextProperty
は指定されたプロパティをウィンドウから取得し、そのデータを
XTextProperty
構造体に格納して返す。
この関数はデータを value フィールドに、データの型を encoding フィール
ドに、データのフォーマットを format フィールドに、データのアイテム数を
nitems フィールドに格納する。
値が NULL である追加のバイトデータ(これは nitems メンバの数には含まれない)が、
text_prop_return の value フィールドの最後に格納される。
プロパティのエンコーディングの解釈やデータをテキストと解釈することは、
関数を呼び出したアプリケーションの裁量に任される。
指定されたプロパティをウィンドウが持っていない場合、
XGetTextProperty
は value フィールドに NULL, encoding フィールドに
None,
format フィールドに 0, nitems フィールドに 0 を設定する。
XTextProperty
構造体のデータの取得や格納ができない場合、
XGetTextProperty
は 0 でないステータスを返す。
それ以外の場合はステータスとして 0 が返される。
XGetTextProperty
はエラー
BadAtom,
BadWindow
を返すことがある。
プロパティ
- WM_CLIENT_MACHINE
-
クライアントアプリケーションが動作しているマシン名を表す文字列。
- WM_COMMAND
-
アプリケーションの起動に使われたコマンドと引き数。これは NULL で終わる文
字列である。
- WM_ICON_NAME
-
アイコンで使われる名前。
- WM_NAME
-
アプリケーションの名前。
返り値
-
BadAlloc
-
要求されたリソースやサーバメモリの割り当てにサーバが失敗した。
-
BadAtom
-
引き数 Atom の値が、定義されている Atom を示していない。
-
BadValue
-
指定された数値に、リクエストの許容範囲を越えているものがある。引き数に対
して特定の範囲が指定されていなければ、引き数の型で定義されている全ての範
囲が許される。選択肢として定義されている引き数はこのエラーを起こすことが
ある。
-
BadWindow
-
引き数 Window に指定された値が、定義された Window を指していない。
関連項目
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)
Xlib - C Language X Interface
Index
- 名前
-
- 書式
-
- 引き数
-
- 説明
-
- プロパティ
-
- 返り値
-
- 関連項目
-
This document was created by
man2html,
using the manual pages.
Time: 15:56:02 GMT, February 12, 2001