Function

GLibfilename_to_utf8

since: 2.0

Declaration 

gchar*
g_filename_to_utf8 (
  const gchar* opsysstring,
  gssize len,
  gsize* bytes_read,
  gsize* bytes_written,
  GError** error
)

Description

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][setlocale].

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 g_convert() to produce output that may contain embedded nul characters.

Available since: 2.0

Parameters

opsysstring

Type: const gchar*

A string in the encoding for filenames.

The data is owned by the caller of the function.
The value is a file system path, using the OS encoding.
len

Type: gssize

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

Type: gsize*

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.

The argument will be set by the function.
The argument can be NULL.
bytes_written

Type: gsize*

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

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 be 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*

The converted string, or NULL on an error.

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.