Method

GdkX11X11Displaystring_to_compound_text

since: 2.24

Declaration [src]

gint
gdk_x11_display_string_to_compound_text (
  GdkDisplay* display,
  const gchar* str,
  GdkAtom* encoding,
  gint* format,
  guchar** ctext,
  gint* length
)

Description [src]

Convert a string from the encoding of the current locale into a form suitable for storing in a window property.

Available since: 2.24

Parameters

str

Type: const gchar*

A nul-terminated string.

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

Type: GdkAtom

Location to store the encoding atom (to be used as the type for the property)

The argument will be set by the function.
The returned data is owned by the instance.
format

Type: gint*

Location to store the format of the property.

The argument will be set by the function.
ctext

Type: An array of guchar*

Location to store newly allocated data for the property.

The argument will be set by the function.
The length of the array is specified in the length argument.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.
length

Type: gint*

The length of ctext, in bytes.

The argument will be set by the function.

Return value

Type: gint

0 upon success, non-zero upon failure.