From: Matthias Clasen Date: Mon, 3 Jan 2005 18:56:20 +0000 (+0000) Subject: Clarify the documentation. (#162251, Mariano Suárez-Alvarez) X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=30425906b51cb6438eea321879e53afcb722af3b;p=dana%2Fcg-glib.git Clarify the documentation. (#162251, Mariano Suárez-Alvarez) 2005-01-03 Matthias Clasen * glib/gfileutils.c (g_file_get_contents): Clarify the documentation. (#162251, Mariano Suárez-Alvarez) --- diff --git a/ChangeLog b/ChangeLog index 5ce08486..716f92ae 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2005-01-03 Matthias Clasen + + * glib/gfileutils.c (g_file_get_contents): Clarify the + documentation. (#162251, Mariano Suárez-Alvarez) + 2005-01-02 Matthias Clasen * glib/gutils.c (g_setenv, g_unsetenv): Clarify the diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 5ce08486..716f92ae 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +2005-01-03 Matthias Clasen + + * glib/gfileutils.c (g_file_get_contents): Clarify the + documentation. (#162251, Mariano Suárez-Alvarez) + 2005-01-02 Matthias Clasen * glib/gutils.c (g_setenv, g_unsetenv): Clarify the diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 5ce08486..716f92ae 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,8 @@ +2005-01-03 Matthias Clasen + + * glib/gfileutils.c (g_file_get_contents): Clarify the + documentation. (#162251, Mariano Suárez-Alvarez) + 2005-01-02 Matthias Clasen * glib/gutils.c (g_setenv, g_unsetenv): Clarify the diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 5ce08486..716f92ae 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +2005-01-03 Matthias Clasen + + * glib/gfileutils.c (g_file_get_contents): Clarify the + documentation. (#162251, Mariano Suárez-Alvarez) + 2005-01-02 Matthias Clasen * glib/gutils.c (g_setenv, g_unsetenv): Clarify the diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 5ce08486..716f92ae 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +2005-01-03 Matthias Clasen + + * glib/gfileutils.c (g_file_get_contents): Clarify the + documentation. (#162251, Mariano Suárez-Alvarez) + 2005-01-02 Matthias Clasen * glib/gutils.c (g_setenv, g_unsetenv): Clarify the diff --git a/glib/gfileutils.c b/glib/gfileutils.c index 8b9c4f7d..d5c5a20a 100644 --- a/glib/gfileutils.c +++ b/glib/gfileutils.c @@ -729,18 +729,21 @@ get_contents_win32 (const gchar *filename, * g_file_get_contents: * @filename: name of a file to read contents from, in the GLib file name encoding * @contents: location to store an allocated string - * @length: location to store length in bytes of the contents - * @error: return location for a #GError + * @length: location to store length in bytes of the contents, or %NULL + * @error: return location for a #GError, or %NULL * * Reads an entire file into allocated memory, with good error - * checking. If @error is set, %FALSE is returned, and @contents is set - * to %NULL. If %TRUE is returned, @error will not be set, and @contents - * will be set to the file contents. The string stored in @contents - * will be nul-terminated, so for text files you can pass %NULL for the - * @length argument. The error domain is #G_FILE_ERROR. Possible - * error codes are those in the #GFileError enumeration. + * checking. + * + * If the call was successful, it returns %TRUE and sets @contents to the file + * contents and @length to the length of the file contents in bytes. The string + * stored in @contents will be nul-terminated, so for text files you can pass + * %NULL for the @length argument. If the call was not successful, it returns + * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error + * codes are those in the #GFileError enumeration. In the error case, + * @contents is set to %NULL and @length is set to zero. * - * Return value: %TRUE on success, %FALSE if error is set + * Return value: %TRUE on success, %FALSE if an error occurred **/ gboolean g_file_get_contents (const gchar *filename,