Method

GdkX11X11Displaytext_property_to_text_list

since: 2.24

Declaration [src]

gint
gdk_x11_display_text_property_to_text_list (
  GdkDisplay* display,
  GdkAtom encoding,
  gint format,
  const guchar* text,
  gint length,
  gchar*** list
)

Description [src]

Convert a text string from the encoding as it is stored in a property into an array of strings in the encoding of the current locale. (The elements of the array represent the nul-separated elements of the original text string.)

Available since: 2.24

Parameters

encoding

Type: GdkAtom

An atom representing the encoding. The most common values for this are STRING, or COMPOUND_TEXT. This is value used as the type for the property.

format

Type: gint

The format of the property.

text

Type: const guchar*

The text data.

The data is owned by the caller of the method.
length

Type: gint

The number of items to transform.

list

Type: gchar***

Location to store an array of strings in the encoding of the current locale. This array should be freed using gdk_free_text_list().

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.

Return value

Type: gint

The number of strings stored in list, or 0, if the conversion failed.