Function

GLibucs4_to_utf8

Declaration

gchar*
g_ucs4_to_utf8 (
  const gunichar* str,
  glong len,
  glong* items_read,
  glong* items_written,
  GError** error
)

Description

Convert a string from a 32-bit fixed width representation as UCS-4. to UTF-8. The result will be terminated with a 0 byte.

Parameters

str

Type: const gunichar*

A UCS-4 encoded string.

The data is owned by the caller of the function.

len

Type: glong

The maximum length (number of characters) of str to use. If len < 0, then the string is nul-terminated.

items_read

Type: glong*

Location to store number of characters read, or NULL.

The argument will be set by the function.

The argument can be NULL.

items_written

Type: glong*

Location to store number of bytes written or NULL. The value here stored does not include the trailing 0 byte.

The argument will be set by the function.

The argument can be NULL.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will left initialized to NULL by the function if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gchar*

A pointer to a newly allocated UTF-8 string. This value must be freed with g_free(). If an error occurs, NULL will be returned and error set. In that case, items_read will be set to the position of the first invalid input character.

The caller of the function takes ownership of the data, and is responsible for freeing it.

The value is a NUL terminated UTF-8 string.