From: Matthias Clasen Date: Fri, 6 Jul 2012 02:25:49 +0000 (-0400) Subject: Improve the g_dir_read_name documentation X-Git-Tag: 2.33.4~40 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ab4cc22ba5d7a1a9ee72eaccd171ac1fc82bfb5c;p=platform%2Fupstream%2Fglib.git Improve the g_dir_read_name documentation This function can return NULL in error cases as well. Document this, and explain how to discriminate the cases. https://bugzilla.gnome.org/show_bug.cgi?id=639771 --- diff --git a/glib/gdir.c b/glib/gdir.c index 3173ae7..e89de89 100644 --- a/glib/gdir.c +++ b/glib/gdir.c @@ -188,7 +188,11 @@ g_dir_open (const gchar *path, * Retrieves the name of another entry in the directory, or %NULL. * The order of entries returned from this function is not defined, * and may vary by file system or other operating-system dependent - * factors. + * factors. + * + * %NULL may also be returned in case of errors. On Unix, you can + * check errno to find out if %NULL was returned + * because of an error. * * On Unix, the '.' and '..' entries are omitted, and the returned * name is in the on-disk encoding. @@ -196,7 +200,7 @@ g_dir_open (const gchar *path, * On Windows, as is true of all GLib functions which operate on * filenames, the returned name is in UTF-8. * - * Return value: The entry's name or %NULL if there are no + * Return value: The entry's name or %NULL if there are no * more entries. The return value is owned by GLib and * must not be modified or freed. **/