to_utf8


Description:

public string to_utf8 (string opsysstring, ssize_t len, out size_t bytes_read, out size_t bytes_written) throws ConvertError

Converts a string which is in the encoding used by GLib for filenames into a UTF-8 string.

Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the current locale.

The input string shall not contain nul characters even if the len argument is positive. A nul character found inside the string will result in error g_convert_error_illegal_sequence. If the source encoding is not UTF-8 and the conversion output contains a nul character, the error g_convert_error_embedded_nul is set and the function returns null. Use convert to produce output that may contain embedded nul characters.

Parameters:

opsysstring

a string in the encoding for filenames

len

the length of the string, 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 len parameter is unsafe)

bytes_read

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 len if there were partial characters at the end of the input. If the error g_convert_error_illegal_sequence occurs, the value stored will be the byte offset after the last valid input sequence.

bytes_written

the number of bytes stored in the output buffer (not including the terminating nul).

Returns:

The converted string, or null on an error.


Namespace: GLib.Filename
Package: glib-2.0



2022 vala-language.org