35 |
|
</funcprototype> |
36 |
|
|
37 |
|
<funcprototype> |
38 |
+ |
<funcdef>sg_error <function>sg_get_error</function></funcdef> |
39 |
+ |
<void/> |
40 |
+ |
</funcprototype> |
41 |
+ |
<funcprototype> |
42 |
+ |
<funcdef>const char *<function>sg_get_error_arg</function></funcdef> |
43 |
+ |
<void/> |
44 |
+ |
</funcprototype> |
45 |
+ |
<funcprototype> |
46 |
+ |
<funcdef>const char *<function>sg_str_error</function></funcdef> |
47 |
+ |
<paramdef>sg_error <parameter>code</parameter></paramdef> |
48 |
+ |
</funcprototype> |
49 |
+ |
|
50 |
+ |
<funcprototype> |
51 |
|
<funcdef>sg_cpu_stats *<function>sg_get_cpu_stats</function></funcdef> |
52 |
|
<void/> |
53 |
|
</funcprototype> |
70 |
|
</funcprototype> |
71 |
|
|
72 |
|
<funcprototype> |
73 |
+ |
<funcdef>sg_fs_stats *<function>sg_get_fs_stats</function></funcdef> |
74 |
+ |
<void/> |
75 |
+ |
</funcprototype> |
76 |
+ |
|
77 |
+ |
<funcprototype> |
78 |
|
<funcdef>sg_host_info *<function>sg_get_host_info</function></funcdef> |
79 |
|
<void/> |
80 |
|
</funcprototype> |
157 |
|
non-zero on failure. |
158 |
|
</para> |
159 |
|
<para> |
160 |
+ |
There are three functions relating to error reporting in libstatgrab. |
161 |
+ |
The first, <function>sg_get_error</function> returns an sg_error code |
162 |
+ |
which relates to the last error generated by libstatgrab. This can be |
163 |
+ |
converted to a string by calling <function>sg_str_error</function> |
164 |
+ |
giving the sg_error code as an argument. Finally, an optional |
165 |
+ |
argument may be set when the error was generated. This can be |
166 |
+ |
accessed by calling <function>sg_get_error_arg</function>. |
167 |
+ |
</para> |
168 |
+ |
<para> |
169 |
+ |
It is the intended practice that whenever a libstatgrab function is |
170 |
+ |
called and subsequently fails that an appropriate error will be set. |
171 |
+ |
</para> |
172 |
+ |
<para> |
173 |
|
The library was originally written to support the i-scream |
174 |
|
central monitoring system, but has since become a standalone |
175 |
|
package. It has been ported to work on Linux, NetBSD, FreeBSD, |
188 |
|
</citerefentry> |
189 |
|
<citerefentry> |
190 |
|
<refentrytitle>sg_get_disk_io_stats</refentrytitle> |
191 |
+ |
<manvolnum>3</manvolnum> |
192 |
+ |
</citerefentry> |
193 |
+ |
<citerefentry> |
194 |
+ |
<refentrytitle>sg_get_fs_stats</refentrytitle> |
195 |
|
<manvolnum>3</manvolnum> |
196 |
|
</citerefentry> |
197 |
|
<citerefentry> |