other versions
- wheezy 4.1.0.20011224-6
XSetWMName(3X11) | XLIB FUNCTIONS | XSetWMName(3X11) |
名前¶
XSetWMName, XGetWMName, XStoreName, XFetchName - ウィンドウの WM_NAME プロパティの設定・取得を行なう書式¶
void XSetWMName( display, w, text_prop)Display * display;
Window w;
XTextProperty * text_prop; Status XGetWMName( display, w, text_prop_return)
Display * display;
Window w;
XTextProperty * text_prop_return; XStoreName( display, w, window_name)
Display * display;
Window w;
char * window_name; Status XFetchName( display, w, window_name_return)
Display * display;
Window w;
char ** window_name_return;
引き数¶
- display
- X サーバへの接続を指定する。
- text_prop
- 使われる XTextProperty 構造体を指定する。
- text_prop_return
- XTextProperty 構造体が返される。
- w
- ウィンドウを指定する。
- window_name
- ウィンドウ名を指定する。 これは NULL で終わる文字列でなければならない。
- window_name_return
- ウィンドウ名が返される。 これは NULL で終わる文字列である。
説明¶
簡易関数 XSetWMName は、 XSetTextProperty を呼び出して WM_NAME プロパティを設定する。 簡易関数 XGetWMName は、 XGetTextProperty を呼び出して WM_NAME プロパティを取得する。 この関数は成功時には 0 でないステータスを返し、そうでない場合には ステータスとして 0 を返す。 関数 XStoreName は window_name に渡された名前を指定されたウィンドウに割り付ける。 ウィンドウマネージャはウィンドウ名をウィンドウの目立つ場所(例えばタイ トルバー)に表示し、ユーザがウィンドウを容易に識別できるようにすることができる。 アプリケーションからアイコン名が与えられた場合、ウィンドウのアイコンに はアイコン名を使うことが推奨されているが、ウィンドウマネージャによっては ウィンドウ名をアイコンに表示するかもしれない。 文字列のエンコーディングがホストポータブル文字エンコーディングでない場 合には、実行結果は実装依存である。 XStoreName はエラー BadAlloc および BadWindow を起こすことがある。 関数 XFetchName は指定したウィンドウの名前を返す。 成功時にはこの関数は 0 でないステータスを返す。 そうでない場合、ウィンドウに名前が設定されたことがあれば、この関数は 0 を返す。 このウィンドウに対して WM_NAME プロパティが1度も設定されたことがなけ れば、 XFetchName は window_name_return に NULL を設定する。 サーバが返す文字列のエンコーディングが Latin ポータブル文字エンコーディ ングであれば、返される文字列のエンコーディングは ホストポータブル文字エンコーディングである。 そうでない場合の結果は実装依存である。 ウィンドウ名の文字列を使い終った後には、クライアントは XFree を使ってこれを解放しなければならない。 XFetchName はエラー BadWindow を起こすことがある。プロパティ¶
- WM_NAME
- アプリケーションの名前。
返り値¶
- BadAlloc
- 要求されたリソースやサーバメモリの割り当てにサーバが失敗した。
- BadWindow
- 引き数 Window の値が、定義されている Window を指していない。
関連項目¶
XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)Release 6.5 | X Version 11 |