| version 1.2, 2002/05/18 18:17:51 |
version 1.3, 2002/05/20 16:10:24 |
|
|
| <!-- $Id$ --> |
<!-- $Id$ --> |
| |
|
| <sect1 id="usage.error-codes"> |
<sect1 id="usage.error-codes"> |
| <title id="usage.error-codes.title">Error codes</title> |
<title id="usage.error-codes.title">Error handling</title> |
| |
|
| <para> |
<para> |
| |
|
| |
These functions are used manipulating with error. &name; itself remember last |
| |
occured error in internal data structures. |
| |
|
| |
<funcsynopsis> |
| |
<funcsynopsisinfo><![CDATA[#include <cfg+.h>]]></funcsynopsisinfo> |
| |
|
| |
<funcprototype> |
| |
<funcdef>void <function>cfg_print_error</function></funcdef> |
| |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| |
</funcprototype> |
| |
|
| |
<funcprototype> |
| |
<funcdef>void <function>cfg_fprint_error</function></funcdef> |
| |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| |
<paramdef>FILE *<parameter>fh</parameter></paramdef> |
| |
</funcprototype> |
| |
|
| |
<funcprototype> |
| |
<funcdef>char *<function>cfg_get_error_str</function></funcdef> |
| |
<paramdef>const CFG_CONTEXT <parameter>con</parameter></paramdef> |
| |
</funcprototype> |
| |
|
| |
<funcprototype> |
| |
<funcdef>char *<function>cfg_get_static_error_str</function></funcdef> |
| |
<paramdef>const int <parameter>errorcode</parameter></paramdef> |
| |
</funcprototype> |
| |
|
| |
</funcsynopsis> |
| |
|
| |
</para> |
| |
<para> |
| |
|
| |
Function <function>cfg_print_error()</function> prints error message of last |
| |
error. Similar function <function>cfg_fprint_error()</function> prints error |
| |
message to specified stream as second parameter <parameter>fh</parameter>. |
| |
|
| |
</para> |
| |
<para> |
| |
|
| |
The last two error manipulating functions returns error message string. First |
| |
one <function>cfg_get_error_str()</function> returns dynamically allocated |
| |
<constant>NUL</constant> array of characters filled with error message. Returned |
| |
pointer must be freed using <function>free()</function> system call. Second function |
| |
returns pointer to local static buffer with error message. It needs error code |
| |
passed as parameter <parameter>errorcode</parameter> to work. |
| |
|
| |
</para> |
| |
<para> |
| |
|
| In following <xref linkend="usage.error-codes.table" |
In following <xref linkend="usage.error-codes.table" |
| endterm="usage.error-codes.table.title"> table are defined possible error |
endterm="usage.error-codes.table.title"> table are defined possible error |
| constants returned by parsing function, which has been described in <xref |
constants returned by parsing function, which has been described in <xref |