XSetTextProperty(3X11)

名前
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 サーバへの接続を指定。

property
    プロパティ名を指定。

text_prop
    使用される 構造体を指定。

text_prop_return
    構造体が返される。

説明
関数 は指定されたウィンドウに対して現在指定されているプロパティのデータ、型、 フォーマット、アイテム数を、指定した 構造体の value フィールド、encoding フィールド、format フィールド、 nitems フィールドでそれぞれ置き換える。 プロパティが以前に指定されていなければ、 はプロパティを指定したウィンドウにセットする。

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

関数 はウィンドウから指定したプロパティを取得し、そのデータを 構造体に格納して返す。 この関数はデータを value フィールドに、データの型を encoding フィール ドに、データのフォーマットを format フィールドに、データのアイテム数を nitems フィールドに格納する。 NULLを含む追加バイト(これは nitems メンバの数には含まれない)は、 text_prop_return の value フィールドの最後に格納される。 プロパティのエンコーディングの解釈やデータをテキストと解釈することは関 数を呼び出したアプリケーションの裁量に任される。 ウィンドウが指定されたプロパティを持っていない場合、 は value フィールドに NULL 、encoding フィールドに に、 format フィールドにゼロ、nitems フィールドにゼロをセットする。

構造体のデータの取得や格納ができない場合、 はゼロでないステータスを返す。 それ以外の場合、ゼロのステータスが返される。

はエラー を返す。

プロパティ

WM_CLIENT_MACHINE
    クライアントアプリケーションが動作しているマシン名を表す文字列。

WM_COMMAND
    アプリケーションの起動に使われたコマンドと引き数。これは NULL で終わる文 字列である。

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

WM_NAME
    アプリケーションの名前。

返り値

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

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

指定された数値に、リクエストの許容範囲を越えているものがある。引き数に対
    して特定の範囲が指定されていなければ、引き数の型で定義されている全ての範 囲が許される。選択肢として定義されている引き数はこのエラーを起こすことが ある。

引き数 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