Function

GLibutf8_to_utf16

Declaration

gunichar2*
g_utf8_to_utf16 (
  const gchar* str,
  glong len,
  glong* items_read,
  glong* items_written,
  GError** error
)

Description

Convert a string from UTF-8 to UTF-16. A 0 character will be added to the result after the converted text.

Parameters

str const gchar*
 

A UTF-8 encoded string.

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

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

items_read glong*
 

Location to store number of bytes read, or NULL. If NULL, then G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here.

 The argument will be set by the function.
 The argument can be NULL.
items_written glong*
 

Location to store number of #gunichar2 written, or NULL. The value stored here does not include the trailing 0.

 The argument will be set by the function.
 The argument can be NULL.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: gunichar2*
 

A pointer to a newly allocated UTF-16 string. This value must be freed with g_free(). If an error occurs, NULL will be returned and error set.

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