diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ref/err.xml | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/doc/ref/err.xml b/doc/ref/err.xml index 50551b5..22dd510 100644 --- a/doc/ref/err.xml +++ b/doc/ref/err.xml @@ -40,17 +40,31 @@ human-readable error information associated with any errors which occur whilst using the HTTP session.</para> - <para>The <function>ne_get_error</function> function returns the current -session error string. This string persists only until it is changed by a -subsequent operation on the session.</para> + <para>The <function>ne_get_error</function> function returns + the current session error string. This string persists only + until it is changed by a subsequent operation on the session. + If localisation was enabled at build time, and if necessary + enabled at run-time if necessary using <xref + linkend="ne_i18n_init"/>, the returned string may have been + translated into the user's current locale.</para> - <para>The <function>ne_set_error</function> function can be -used to set a new session error string, using a -<function>printf</function>-style format string interface.</para> + <para>The <function>ne_set_error</function> function can be + used to set a new session error string, using a + <function>printf</function>-style format string + interface.</para> </refsect1> <refsect1> + <title>Return value</title> + + <para><function>ne_set_error</function> returns a constant + &nul;-terminated string. In the default English locale, the + returned string will <emphasis>not</emphasis> have a + terminating <quote>.</quote> period character.</para> + </refsect1> + + <refsect1> <title>Examples</title> <para>Retrieve the current error string:</para> <programlisting>&egsess; |