<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Open SCAP Library: Error reporting</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> </div> <div class="contents"> <h1>Error reporting<br/> <small> [<a class="el" href="group__COMMON.html">COMMON</a>]</small> </h1> <p>OpenSCAP error reporting & logging mechanism. <a href="#_details">More...</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf92cadc8126f2faecc2f4b0bb66bef48"></a><!-- doxytag: member="ERRORS::oscap_seterr" ref="gaf92cadc8126f2faecc2f4b0bb66bef48" args="(family, code, desc)" --> #define </td><td class="memItemRight" valign="bottom"><b>oscap_seterr</b>(family, code, desc) __oscap_seterr (__FILE__, __LINE__, __PRETTY_FUNCTION__, family, code, desc)</td></tr> <tr><td colspan="2"><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaddebbc97e12a87b46b37d236660deb9"></a><!-- doxytag: member="ERRORS::oscap_errfamily_t" ref="gaaddebbc97e12a87b46b37d236660deb9" args="" --> typedef uint16_t </td><td class="memItemRight" valign="bottom"><b>oscap_errfamily_t</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga200ca968e978cd3f3020f3eaa1e4d18b"></a><!-- doxytag: member="ERRORS::oscap_errcode_t" ref="ga200ca968e978cd3f3020f3eaa1e4d18b" args="" --> typedef uint16_t </td><td class="memItemRight" valign="bottom"><b>oscap_errcode_t</b></td></tr> <tr><td colspan="2"><h2>Error manipulation functions</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrp8fc0b83efb891a68c7b2a7bdc9438494"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5270a0e3456a9b41ef0699172039f9bb"></a><!-- doxytag: member="ERRORS::__oscap_seterr" ref="ga5270a0e3456a9b41ef0699172039f9bb" args="(const char *file, uint32_t line, const char *func, oscap_errfamily_t family, oscap_errcode_t code, const char *desc)" --> void </td><td class="memItemRight" valign="bottom"><b>__oscap_seterr</b> (const char *file, uint32_t line, const char *func, oscap_errfamily_t family, oscap_errcode_t code, const char *desc)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga460f0799ef0d3718e656525d78b3f77d"></a><!-- doxytag: member="ERRORS::oscap_clearerr" ref="ga460f0799ef0d3718e656525d78b3f77d" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga460f0799ef0d3718e656525d78b3f77d">oscap_clearerr</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clear an error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6250756dc15760ad37288410b1117433"></a><!-- doxytag: member="ERRORS::oscap_err" ref="ga6250756dc15760ad37288410b1117433" args="(void)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga6250756dc15760ad37288410b1117433">oscap_err</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check for an error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf5a130197519ab79f452a592c327c89b"></a><!-- doxytag: member="ERRORS::oscap_err_family" ref="gaf5a130197519ab79f452a592c327c89b" args="(void)" --> oscap_errfamily_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaf5a130197519ab79f452a592c327c89b">oscap_err_family</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get last error family. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7a04a1e9253a5097bf25c1520ab75c58"></a><!-- doxytag: member="ERRORS::oscap_err_code" ref="ga7a04a1e9253a5097bf25c1520ab75c58" args="(void)" --> oscap_errcode_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga7a04a1e9253a5097bf25c1520ab75c58">oscap_err_code</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get last error code. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga40156d16cfcddd2596f56b9fcc5f752f"></a><!-- doxytag: member="ERRORS::oscap_err_desc" ref="ga40156d16cfcddd2596f56b9fcc5f752f" args="(void)" --> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get last error description. <br/></td></tr> <tr><td colspan="2"><h2>Error levels</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrpd22b90f74e21847842a86a376480c5d5"></a>Error level (as defined in XML error handler library).</p> <p>Maybe for future use. </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0ed353169f944f7e4d075e6c462511b1"></a><!-- doxytag: member="ERRORS::OSCAP_ELEVEL_NONE" ref="ga0ed353169f944f7e4d075e6c462511b1" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga0ed353169f944f7e4d075e6c462511b1">OSCAP_ELEVEL_NONE</a> 0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">None. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad0c7a798b14ee03a65f26059b3228a1d"></a><!-- doxytag: member="ERRORS::OSCAP_ELEVEL_WARNING" ref="gad0c7a798b14ee03a65f26059b3228a1d" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gad0c7a798b14ee03a65f26059b3228a1d">OSCAP_ELEVEL_WARNING</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A simple warning. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab494886d54bb962830923f1f37e38f69"></a><!-- doxytag: member="ERRORS::OSCAP_ELEVEL_ERROR" ref="gab494886d54bb962830923f1f37e38f69" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gab494886d54bb962830923f1f37e38f69">OSCAP_ELEVEL_ERROR</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A recoverable error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3b392fe03aa1ba3c84006d3adec7575c"></a><!-- doxytag: member="ERRORS::OSCAP_ELEVEL_FATAL" ref="ga3b392fe03aa1ba3c84006d3adec7575c" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga3b392fe03aa1ba3c84006d3adec7575c">OSCAP_ELEVEL_FATAL</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A fatal error. <br/></td></tr> <tr><td colspan="2"><h2>Error families</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrpe6878bcea0e82ac743e7b9c507940d05"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2a4b222f295b167554e471b040639383"></a><!-- doxytag: member="ERRORS::OSCAP_EFAMILY_NONE" ref="ga2a4b222f295b167554e471b040639383" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga2a4b222f295b167554e471b040639383">OSCAP_EFAMILY_NONE</a> 0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">None. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacc53d2370c80b6ed73177e50cadd9dff"></a><!-- doxytag: member="ERRORS::OSCAP_EFAMILY_GLIBC" ref="gacc53d2370c80b6ed73177e50cadd9dff" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gacc53d2370c80b6ed73177e50cadd9dff">OSCAP_EFAMILY_GLIBC</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Errno errors. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5c221a396c86b253134dcf2cdd8fffc6"></a><!-- doxytag: member="ERRORS::OSCAP_EFAMILY_XML" ref="ga5c221a396c86b253134dcf2cdd8fffc6" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga5c221a396c86b253134dcf2cdd8fffc6">OSCAP_EFAMILY_XML</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Libxml - xmlerror errors. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga063ef25dbff56281ad8b88bd3e5637a2"></a><!-- doxytag: member="ERRORS::OSCAP_EFAMILY_OSCAP" ref="ga063ef25dbff56281ad8b88bd3e5637a2" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga063ef25dbff56281ad8b88bd3e5637a2">OSCAP_EFAMILY_OSCAP</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">OSCAP errors. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac0e81243524424435f8099c768fd3ab3"></a><!-- doxytag: member="ERRORS::OSCAP_EFAMILY_OVAL" ref="gac0e81243524424435f8099c768fd3ab3" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gac0e81243524424435f8099c768fd3ab3">OSCAP_EFAMILY_OVAL</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">OVAL errors (OVAL & probes). <br/></td></tr> <tr><td colspan="2"><h2>OSCAP family error codes</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrp19306857d8f8a575e64d0fd228f77282"></a></p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ERRORS.html#ga063ef25dbff56281ad8b88bd3e5637a2" title="OSCAP errors.">OSCAP_EFAMILY_OSCAP</a> </dd></dl> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaae500549b229e017c725e9966cd2a2c4"></a><!-- doxytag: member="ERRORS::OSCAP_ENONE" ref="gaae500549b229e017c725e9966cd2a2c4" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaae500549b229e017c725e9966cd2a2c4">OSCAP_ENONE</a> 0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">None. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf91e97093f1908b1f17107f6eeedde56"></a><!-- doxytag: member="ERRORS::OSCAP_EALLOC" ref="gaf91e97093f1908b1f17107f6eeedde56" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaf91e97093f1908b1f17107f6eeedde56">OSCAP_EALLOC</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">OSCAP allocation error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f49cf2c3395080d9e20eb4929f1e4c1"></a><!-- doxytag: member="ERRORS::OSCAP_EXMLELEM" ref="ga7f49cf2c3395080d9e20eb4929f1e4c1" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga7f49cf2c3395080d9e20eb4929f1e4c1">OSCAP_EXMLELEM</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Unknown element in XML. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga46726341cece72639c5f2b4fc7295516"></a><!-- doxytag: member="ERRORS::OSCAP_EXMLNODETYPE" ref="ga46726341cece72639c5f2b4fc7295516" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga46726341cece72639c5f2b4fc7295516">OSCAP_EXMLNODETYPE</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Bad node type in XML. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga27e56d550fd6b4552d121ca3a8ae4d56"></a><!-- doxytag: member="ERRORS::OSCAP_EXMLNOELEMENT" ref="ga27e56d550fd6b4552d121ca3a8ae4d56" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga27e56d550fd6b4552d121ca3a8ae4d56">OSCAP_EXMLNOELEMENT</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">No expected element. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9699911605704906159aabccdf4a91f5"></a><!-- doxytag: member="ERRORS::OSCAP_ECPEINVOP" ref="ga9699911605704906159aabccdf4a91f5" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga9699911605704906159aabccdf4a91f5">OSCAP_ECPEINVOP</a> 5</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Invalid CPE Language operation. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b7d8374463e1b1f8fbcbaa29a3cd881"></a><!-- doxytag: member="ERRORS::OSCAP_EOVALINT" ref="ga7b7d8374463e1b1f8fbcbaa29a3cd881" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga7b7d8374463e1b1f8fbcbaa29a3cd881">OSCAP_EOVALINT</a> 6</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">OVAL internal error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga69e77261ac3dff2ff961e7c08a719d33"></a><!-- doxytag: member="ERRORS::OSCAP_EREGEXP" ref="ga69e77261ac3dff2ff961e7c08a719d33" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga69e77261ac3dff2ff961e7c08a719d33">OSCAP_EREGEXP</a> 7</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Error in regexp compilation. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga632665abf7879d5d83f72e9eeda8fc8a"></a><!-- doxytag: member="ERRORS::OSCAP_EREGEXPCOMP" ref="ga632665abf7879d5d83f72e9eeda8fc8a" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga632665abf7879d5d83f72e9eeda8fc8a">OSCAP_EREGEXPCOMP</a> 8</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Invalid string comparison in regexps. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga176ff2af193aea64e6c04937cab7559b"></a><!-- doxytag: member="ERRORS::OSCAP_EUNDATATYPE" ref="ga176ff2af193aea64e6c04937cab7559b" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga176ff2af193aea64e6c04937cab7559b">OSCAP_EUNDATATYPE</a> 9</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Unsupported data type. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa703884800f0698cec4b4c962c2dbceb"></a><!-- doxytag: member="ERRORS::OSCAP_EINVARG" ref="gaa703884800f0698cec4b4c962c2dbceb" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaa703884800f0698cec4b4c962c2dbceb">OSCAP_EINVARG</a> 10</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Invalid argument. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0302d365e7db2adf84ea1d6c73b9d382"></a><!-- doxytag: member="ERRORS::OSCAP_EVARTYPE" ref="ga0302d365e7db2adf84ea1d6c73b9d382" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga0302d365e7db2adf84ea1d6c73b9d382">OSCAP_EVARTYPE</a> 11</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Variable type is not valid. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f036c14907d908874999d9ede0a77af"></a><!-- doxytag: member="ERRORS::OSCAP_ESEAPINIT" ref="ga7f036c14907d908874999d9ede0a77af" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga7f036c14907d908874999d9ede0a77af">OSCAP_ESEAPINIT</a> 12</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Failed seap initialization. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga59786eea4688dba343c2040528eebda1"></a><!-- doxytag: member="ERRORS::OSCAP_EUSER1" ref="ga59786eea4688dba343c2040528eebda1" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga59786eea4688dba343c2040528eebda1">OSCAP_EUSER1</a> 201</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">User defined error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaee2c1605819089fe132e0d0efd375445"></a><!-- doxytag: member="ERRORS::OSCAP_EUSER2" ref="gaee2c1605819089fe132e0d0efd375445" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaee2c1605819089fe132e0d0efd375445">OSCAP_EUSER2</a> 202</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">User defined error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaa2f59e51ab637af202c9147f5b61acc"></a><!-- doxytag: member="ERRORS::OSCAP_ENOTIMPL" ref="gaaa2f59e51ab637af202c9147f5b61acc" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaaa2f59e51ab637af202c9147f5b61acc">OSCAP_ENOTIMPL</a> 254</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Not implemented. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3246fd5141f9216a29b81f95dfe557f6"></a><!-- doxytag: member="ERRORS::OSCAP_EUNKNOWN" ref="ga3246fd5141f9216a29b81f95dfe557f6" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga3246fd5141f9216a29b81f95dfe557f6">OSCAP_EUNKNOWN</a> 255</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Unknown/Unexpected error. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>OpenSCAP error reporting & logging mechanism. </p> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on 26 Feb 2010 for Open SCAP Library by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>