Other Alias
XSetWMIconName, XSetIconName, XGetIconName書式
void XSetWMIconName(display, w, text_prop)Display *display;
Window w;
XTextProperty *text_prop;
Status XGetWMIconName(display, w, text_prop_return)
Display *display;
Window w;
XTextProperty *text_prop_return;
XSetIconName(display, w, icon_name)
Display *display;
Window w;
char *icon_name;
Status XGetIconName(display, w, icon_name_return)
Display *display;
Window w;
char **icon_name_return;
引き数
- display
- X サーバへの接続を指定する。
- icon_name
- アイコン名を指定する。 これは NULL で終わる文字列でなければならない。
- icon_name_return
- ウィンドウのアイコン名が返される。 これは NULL で終わる文字列である。
- text_prop
- 使われる XTextProperty 構造体を指定する。
- text_prop_return
- XTextProperty 構造体が返される。
- w
- ウィンドウを指定する。
説明
簡易関数 XSetWMIconName は、 XSetTextProperty を呼び出して WM_ICON_NAME プロパティを設定する。簡易関数 XGetWMIconName は、 XGetTextProperty を呼び出して WM_ICON_NAME プロパティを取得する。 この関数は成功時に 0 でないステーテスを返し、そうでない場合には ステータスとして 0 を返す。
関数 XSetIconName はウィンドウのアイコンに表示される名前を設定する。
XSetIconName はエラー BadAlloc, BadWindow を起こすことがある。
関数 XGetIconName は指定したウィンドウのアイコンに表示すべき名前を返す。 この関数は成功の場合には 0 でないステータスを返す。 そうでない場合は、ウィンドウに対するアイコン名が設定されていなければ 0 を返す。 今までウィンドウに名前が一度も付けられていなければ、 XGetIconName は icon_name_return に NULL を設定する。 サーバが返すデータが Latin ポータブル文字エンコーディングの場合には、 返される文字列のエンコーディングはホストポータブル文字エンコーディング である。 そうでない場合の結果は実装依存である。 アイコン名の文字列を使い終った後には、クライアントはこの文字列を XFree を使って解放しなければならない。
XGetIconName はエラー BadWindow を起こすことがある。
プロパティ
- WM_ICON_NAME
- アイコンで使われる名前。
返り値
- BadAlloc
- 要求したリソースやサーバメモリの割り当てにサーバが失敗した。
- BadWindow
- 引き数 Window の値が、定義されている Window を指していない。