Converts a string from one character set to another.
Note that you should use iconv for streaming conversions. Despite the fact that
bytes_read can return information about partial characters, the g_convert_... functions are not generally suitable for streaming.
If the underlying converter maintains internal state, then this won't be preserved across successive calls to
convert, convert_with_iconv or
convert_with_fallback. (An example of this is the GNU C converter for
CP1255 which does not emit a base character until it knows that the next character is not a mark that could combine with the base character.)
Characters which are valid in the input character set, but which have no representation in the output character set will result in a
g_convert_error_illegal_sequence error. This is in contrast to the
iconv specification, which
leaves this behaviour implementation defined. Note that this is the same error code as is returned for an invalid byte sequence in the input
character set. To get defined behaviour for conversion of unrepresentable characters, use
the string to convert.
conversion descriptor from open
location to store the number of bytes in the input string that were successfully converted, or null.
Even if the conversion was successful, this may be less than
the number of bytes stored in the output buffer (not including the terminating nul).
the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside
strings. In that case, using -1 for the
If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free. Otherwise null and throws will be set.