Function

Gdk-3.0 ▶ Gdk ▶ property_get

  • Retrieves a portion of the contents of a property. If the property does not exist, then the function returns false, and GDK_NONE will be stored in actual_property_type.

    The XGetWindowProperty() function that gdk_property_get() uses has a very confusing and complicated set of semantics. Unfortunately, gdk_property_get() makes the situation worse instead of better (the semantics should be considered undefined), and also prints warnings to stderr in cases where it should return a useful error to the program. You are advised to use XGetWindowProperty() directly until a replacement function for gdk_property_get() is provided.

    Parameters

    • window: Gdk.Window

      a Gdk.Window

    • property: Gdk.Atom

      the property to retrieve

    • type: Gdk.Atom

      the desired property type, or GDK_NONE, if any type of data is acceptable. If this does not match the actual type, then actual_format and actual_length will be filled in, a warning will be printed to stderr and no data will be returned.

    • offset: number

      the offset into the property at which to begin retrieving data, in 4 byte units.

    • length: number

      the length of the data to retrieve in bytes. Data is considered to be retrieved in 4 byte chunks, so length will be rounded up to the next highest 4 byte boundary (so be careful not to pass a value that might overflow when rounded up).

    • pdelete: number

      if true, delete the property after retrieving the data.

    Returns [boolean, Gdk.Atom, number, Uint8Array<ArrayBufferLike>]

    true if data was successfully received and stored in data, otherwise false.