luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-09-28 01:57:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify expectations with error codes like G_IO_ERROR_FAILED

Browse Source 
If an error code enumeration is expected to be extended in the future,
people shouldn't compare explicitly against its generic "FAILED" value.

https://bugzilla.gnome.org/show_bug.cgi?id=726775
This commit is contained in:
Dan Winship
2014-03-20 09:25:19 -04:00
parent 9c19f6dfa1
commit c67d23aa2f
3 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
gio/gioerror.c
View File

@@ -44,7 +44,10 @@ G_DEFINE_QUARK (g-io-error-quark, g_io_error)
* g_io_error_from_errno:
* @err_no: Error number as defined in errno.h.
*
* Converts errno.h error codes into GIO error codes.
* Converts errno.h error codes into GIO error codes. The fallback
* value %G_IO_ERROR_FAILED is returned for error codes not currently
* handled (but note that future GLib releases may return a more
* specific value instead).
*
* Returns: #GIOErrorEnum value for the given errno.h error number.
**/
@@ -229,9 +232,10 @@ g_io_error_from_errno (gint err_no)
* g_io_error_from_win32_error:
* @error_code: Windows error number.
*
* Converts some common error codes into GIO error codes. The
* fallback value G_IO_ERROR_FAILED is returned for error codes not
* handled.
* Converts some common error codes into GIO error codes. The fallback
* value %G_IO_ERROR_FAILED is returned for error codes not currently
* handled (but note that future GLib releases may return a more
* specific value instead).
*
* Returns: #GIOErrorEnum value for the given error number.
*