名称

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;

引数

displayX サーバへの接続を指定します。

icon_nameナルで終わる文字列のアイコン名を指定します。

icon_name_return
ナルで終わる文字列のウィンドウのアイコン名を返します。

text_propXTextProperty 構造体を指定します。

text_prop_return
XTextProperty 構造体を返します。

wウィンドウを指定します。

解説

XSetWMIconName 関数は XSetTextProperty を呼んで、WM_ICON_NAME 属性を設定します。 XGetWMIconName 関数は XGetTextProperty を呼んで、WM_ICON_NAME 属性を得ます。 成功した場合は、ゼロ以外のステータスを、 それ以外の場合はゼロを返します。 XSetIconName 関数はウィンドウアイコンに表示される名称を設定します。 XSetIconName で発生するエラーには、 BadAlloc および BadWindow エラーがあります。 XGetIconName 関数は指定ウィンドウのアイコンに表示される名称を返します。 それが巧く行われれば、 ゼロ以外の値を返します。 そうならず、 ウィンドウのアイコン名が設定されなければ、 ゼロを返します。 ウィンドウに名称をまったく割り当てなければ、 XGetIconName は icon_name_return をナルに設定します。 サーバが返したデータが、 ラテンポータブル文字コード (Latin Portable Character Encoding) にある場合は、返される文字列は ホストポータブル文字コード (Host Portable Character Encoding) になります。 それ以外の場合、結果はインプリメンテーションにより異なります。 必要が無くなった場合は、 クライアント側で XFree を使って、 アイコン名の文字列を解放しなければなりません。 XGetIconName で発生するエラーには、 BadWindow エラーがあります。

属性

WM_ICON_NAME
アイコンで使用される名称

診断

BadAlloc サーバがリクエストされたリソースまたはサーバメモリの割り当てに失敗した。

BadWindow
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

NEWS-OSRelease 4.2.1R