Function

GLibfilename_from_utf8

Declaration

gchar*
g_filename_from_utf8 (
  const gchar* utf8string,
  gssize len,
  gsize* bytes_read,
  gsize* bytes_written,
  GError** error
)

Description

Converts a string from UTF-8 to the encoding GLib uses for filenames. 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 filename 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.

Parameters

utf8string const gchar*
 

A UTF-8 encoded string.

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

The length of the string, or -1 if the string is nul-terminated.

bytes_read 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.
 The called function takes ownership of the data, and is responsible for freeing it.
bytes_written 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.
 The called function takes ownership of the data, and is responsible for freeing it.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: filename
 
          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 string is a file system path, using the OS encoding.