GError: small documentation addition

Document that out variables are not guaranteed to be set to
defined values if an error is thrown. Inspired by bug 658315
This commit is contained in:
Matthias Clasen 2012-01-15 23:18:09 -05:00
parent 5377c0de01
commit 186c15fc87

View File

@ -265,7 +265,7 @@
* <listitem><para> * <listitem><para>
* The quark function for the error domain is called * The quark function for the error domain is called
* <literal>&lt;namespace&gt;_&lt;module&gt;_error_quark</literal>, * <literal>&lt;namespace&gt;_&lt;module&gt;_error_quark</literal>,
* for example g_spawn_error_quark() or %g_thread_error_quark(). * for example g_spawn_error_quark() or g_thread_error_quark().
* </para></listitem> * </para></listitem>
* <listitem><para> * <listitem><para>
* The error codes are in an enumeration called * The error codes are in an enumeration called
@ -315,6 +315,10 @@
* immediately. * immediately.
* </para></listitem> * </para></listitem>
* <listitem><para> * <listitem><para>
* If a #GError is reported, out parameters are not guaranteed to
* be set to any defined value.
* </para></listitem>
* <listitem><para>
* A #GError* must be initialized to %NULL before passing its address * A #GError* must be initialized to %NULL before passing its address
* to a function that can report errors. * to a function that can report errors.
* </para></listitem> * </para></listitem>