XSetWMIconName(3X11)

名前
XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName - ウィンドウの WM_ICON_NAME プロパティの設定・取得

書式
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
    使用される 構造体を指定。

text_prop_return
    構造体を返す。

w   ウィンドウを指定。

説明
簡易関数 は、 を呼び出して WM_ICON_NAME プロパティをセットする。

コンビニエンス関数 は、 を呼び出して WM_ICON_NAME プロパティを取得する。 この関数は成功時にゼロでないステーテスを返し、そうでない場合にはゼロの ステータスを返す。

関数 はウィンドウのアイコンに表示される名前を設定する。

はエラー を起こすことがある。

関数 は指定したウィンドウのアイコンに表示される名前を返す。 成功の場合にはゼロでないステータスを返す。 そうでない場合は、ウィンドウに対するアイコン名がセットされていなければ ゼロを返す。 今までウィンドウに名前が一度も付けられていなければ、 は icon_name_return に NULL をセットする。 サーバが返すデータが Latin ポータブル文字エンコーディングの場合には、 返される文字列のエンコーディングはホストポータブル文字エンコーディング である。 そうでない場合の結果は実装依存である。 アイコン名の文字列を使い終った後には、クライアントはこの文字列を を使って解放しなければならない。

はエラー を起こすことがある。

プロパティ

WM_ICON_NAME
    アイコンで使われる名前。

返り値

サーバが、要求したリソースやサーバメモリのアロケートに失敗した。

引き数 Window の値が、定義されている Window を指していない。

関連項目
XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
Xlib - C Language X Interface