to_utf16


Description:

[ CCode ( cname = "g_utf8_to_utf16" ) ]
public string16 to_utf16 (long len = -1, out long items_read = null, out long items_written = null) throws ConvertError

Convert a string from UTF-8 to UTF-16.

A nul character (U+0000) will be added to the result after the converted text.

Parameters:

len

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

items_read

location to store number of bytes read, or `NULL` to ignore. If `NULL`, then [error@GLib.ConvertError.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 value stored here will never be negative.

items_written

location to store number of `gunichar2` written, or `NULL` to ignore. The value stored here does not include the trailing nul, and will never be negative.

str

a UTF-8 encoded string

Returns:

a pointer to a newly allocated UTF-16 string. This value must be freed with [func@GLib.free].