luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

g_file_new_for_commandline_arg: clarify encoding

Browse Source 
Add a note to the documentation for g_file_new_for_commandline_arg()
that this function is intended to operate on strings already in the GLib
filename encoding on Windows.

This has been the case for a long time, but this documents the
requirement.

https://bugzilla.gnome.org/show_bug.cgi?id=722025
This commit is contained in:
Ryan Lortie 2014-01-16 22:11:18 -05:00
parent 673ee54cdd
commit 643f2b348d
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gio/gfile.c
View File

@ -6462,6 +6462,15 @@ new_for_cmdline_arg (const gchar *arg,
* This operation never fails, but the returned object might not * This operation never fails, but the returned object might not
* support any I/O operation if @arg points to a malformed path. * support any I/O operation if @arg points to a malformed path.
* *
* Note that on Windows, this function expects its argument to be in
* UTF-8 -- not the system code page. This means that you
* should not use this function with string from argv as it is passed
* to main(). g_win32_get_command_line() will return a UTF-8 version of
* the commandline. #GApplication also uses UTF-8 but
* g_application_command_line_create_file_for_arg() may be more useful
* for you there. It is also always possible to use this function with
* #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
*
* Returns: (transfer full): a new #GFile. * Returns: (transfer full): a new #GFile.
* Free the returned object with g_object_unref(). * Free the returned object with g_object_unref().
*/ */