--- projects/libstatgrab/docs/libstatgrab/statgrab.xml	2004/05/02 17:39:19	1.8
+++ projects/libstatgrab/docs/libstatgrab/statgrab.xml	2004/05/04 19:28:06	1.9
@@ -6,8 +6,8 @@
 <refentry id="statgrab">
 
   <refentryinfo>
-    <date>$Date: 2004/05/02 17:39:19 $</date>
-    <releaseinfo>$Id: statgrab.xml,v 1.8 2004/05/02 17:39:19 tdb Exp $</releaseinfo>
+    <date>$Date: 2004/05/04 19:28:06 $</date>
+    <releaseinfo>$Id: statgrab.xml,v 1.9 2004/05/04 19:28:06 tdb Exp $</releaseinfo>
   </refentryinfo>
 
   <refmeta>
@@ -35,6 +35,19 @@
       </funcprototype>
 
       <funcprototype>
+        <funcdef>sg_error <function>sg_get_error</function></funcdef>
+        <void/>
+      </funcprototype>
+      <funcprototype>
+        <funcdef>const char *<function>sg_get_error_arg</function></funcdef>
+        <void/>
+      </funcprototype>
+      <funcprototype>
+        <funcdef>const char *<function>sg_str_error</function></funcdef>
+        <paramdef>sg_error <parameter>code</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
         <funcdef>sg_cpu_stats *<function>sg_get_cpu_stats</function></funcdef>
         <void/>
       </funcprototype>
@@ -137,6 +150,19 @@
       <function>sg_init</function> and
       <function>sg_drop_privileges</function> return 0 on success, and
       non-zero on failure.
+    </para>
+    <para>
+      There are three functions relating to error reporting in libstatgrab.
+      The first, <function>sg_get_error</function> returns an sg_error code
+      which relates to the last error generated by libstatgrab. This can be
+      converted to a string by calling <function>sg_str_error</function>
+      giving the sg_error code as an argument. Finally, an optional
+      argument may be set when the error was generated. This can be
+      accessed by calling <function>sg_get_error_arg</function>.
+    </para>
+    <para>
+      It is the intended practice that whenever a libstatgrab function is
+      called and subsequently fails that an appropriate error will be set.
     </para>
     <para>
       The library was originally written to support the i-scream