XGetWindowProperty

Syntax

int XGetWindowProperty(display, w, property, long_offset, long_length, delete, req_type, 
                        actual_type_return, actual_format_return, nitems_return, bytes_after_return, 
                        prop_return)
      Display *display;
      Window w;
      Atom property;
      long long_offset, long_length;
      Bool delete;
      Atom req_type; 
      Atom *actual_type_return;
      int *actual_format_return;
      unsigned long *nitems_return;
      unsigned long *bytes_after_return;
      unsigned char **prop_return;

Arguments

Description

• If the specified property does not exist for the specified window, XGetWindowProperty() returns None to actual_type_return and the value zero to actual_format_return and bytes_after_return. The nitems_return argument is empty. In this case, the delete argument is ignored.
  指定したウィンドウに対する指定したプロパティが存在しない場合、 XGetWindowProperty() は actual_type_return に None を返し、 actual_format_return と bytes_after_return にゼロを返す。 引き数 nitems_return は空になる。 この場合には引き数 delete は無視される。

• If the specified property exists but its type does not match the specified type, XGetWindowProperty() returns the actual property type to actual_type_return, the actual property format (never zero) to actual_format_return, and the property length in bytes (even if the actual_format_return is 16 or 32) to bytes_after_return. It also ignores the delete argument. The nitems_return argument is empty.
  指定したプロパティは存在するが指定したタイプに一致しない場合、 XGetWindowProperty() は actual_type_return に実際のプロパティのタイプ、 actual_format_return に実際のプロパティのフォーマット (決してゼロにはならない)、 bytes_after_return にプロパティのバイト長 (actual_format_return が 16 または 32 であっても) を返す。 この場合も引き数 delete は無視される。 引き数 nitems_return は空である。

• If the specified property exists and either you assign AnyPropertyType to the req_type argument or the specified type matches the actual property type, XGetWindowProperty() returns the actual property type to actual_type_return and the actual property format (never zero) to actual_format_return. It also returns a value to bytes_after_return and nitems_return, by defining the following values:
  指定したプロパティが存在し、 かつ引き数 req_type に AnyPropertyType を指定するか、 指定したタイプが実際のプロパティと一致した場合は、 XGetWindowProperty() は actual_type_return に実際のプロパティのタイプ、 actual_format_return に実際のプロパティのフォーマット (決してゼロにならない) を返す。 また以下で定義する値を bytes_after_return と nitems_return に返す。

  N = actual length of the stored property in bytes (even if the format is 16 or 32)
  I = 4 * long_offset
  T = N - I
  L = MINIMUM(T, 4 * long_length)
  A = N - (I + L)
  

  The returned value starts at byte index I in the property (indexing from zero), and its length in bytes is L. If the value for long_offset causes L to be negative, a BadValue error results. The value of bytes_after_return is A, giving the number of trailing unread bytes in the stored property.
  返される値は (ゼロから数えて) I 番目のバイトから始まり、 長さは L バイトである。 long_offset の値により L が負の値になった場合、 エラー BadValue となる。 bytes_after_return の値は A である。 これは格納されているプロパティ内に残っていてまだ読んでいないバイト数である。

XGetWindowProperty() always allocates one extra byte in prop_return (even if the property is zero length) and sets it to zero so that simple properties consisting of characters do not have to be copied into yet another string before use.
XGetWindowProperty() は常に prop_return に追加の 1 バイトをアロケートし (たとえプロパティの長さがゼロでも)、 そこにゼロをセットする。 文字からなる簡単なプロパティを、 使用前に別の文字列にコピーする必要がないようにするためである。

If delete is True and bytes_after_return is zero, XGetWindowProperty() deletes the property from the window and generates a PropertyNotify event on the window.
delete が True で bytes_after_return がゼロならば、 XGetWindowProperty() はプロパティをウィンドウから削除し、 そのウィンドウ上に PropertyNotify イベントを生成する。

The function returns Success if it executes successfully. To free the resulting data, use XFree().
この関数は正常に実行された場合、 Success を返す。 得られたデータを解放するには XFree() を使用すること。

XGetWindowProperty() can generate BadAtom, BadValue , and BadWindow errors.
XGetWindowProperty() はエラー BadAtom, BadValue , BadWindow を起こすことがある。

Diagnostics

See also