1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>Open SCAP Library: Errors</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Errors<div class="ingroups"><a class="el" href="group__COMMON.html">Common</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Error checking mechanism.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaaddebbc97e12a87b46b37d236660deb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaddebbc97e12a87b46b37d236660deb9"></a>
typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaaddebbc97e12a87b46b37d236660deb9">oscap_errfamily_t</a></td></tr>
<tr class="memdesc:gaaddebbc97e12a87b46b37d236660deb9"><td class="mdescLeft"> </td><td class="mdescRight">Error family type. <br/></td></tr>
<tr class="separator:gaaddebbc97e12a87b46b37d236660deb9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga460f0799ef0d3718e656525d78b3f77d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga460f0799ef0d3718e656525d78b3f77d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga460f0799ef0d3718e656525d78b3f77d">oscap_clearerr</a> (void)</td></tr>
<tr class="memdesc:ga460f0799ef0d3718e656525d78b3f77d"><td class="mdescLeft"> </td><td class="mdescRight">Clear an error. <br/></td></tr>
<tr class="separator:ga460f0799ef0d3718e656525d78b3f77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6250756dc15760ad37288410b1117433"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6250756dc15760ad37288410b1117433"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga6250756dc15760ad37288410b1117433">oscap_err</a> (void)</td></tr>
<tr class="memdesc:ga6250756dc15760ad37288410b1117433"><td class="mdescLeft"> </td><td class="mdescRight">Check for an error. <br/></td></tr>
<tr class="separator:ga6250756dc15760ad37288410b1117433"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf5a130197519ab79f452a592c327c89b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf5a130197519ab79f452a592c327c89b"></a>
<a class="el" href="group__ERRORS.html#gaaddebbc97e12a87b46b37d236660deb9">oscap_errfamily_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaf5a130197519ab79f452a592c327c89b">oscap_err_family</a> (void)</td></tr>
<tr class="memdesc:gaf5a130197519ab79f452a592c327c89b"><td class="mdescLeft"> </td><td class="mdescRight">Get last error family. <br/></td></tr>
<tr class="separator:gaf5a130197519ab79f452a592c327c89b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40156d16cfcddd2596f56b9fcc5f752f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga40156d16cfcddd2596f56b9fcc5f752f"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> (void)</td></tr>
<tr class="memdesc:ga40156d16cfcddd2596f56b9fcc5f752f"><td class="mdescLeft"> </td><td class="mdescRight">Get last error description. <br/></td></tr>
<tr class="separator:ga40156d16cfcddd2596f56b9fcc5f752f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75a2a4b96d3c6ab06845c6cd0e37b15d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> (void)</td></tr>
<tr class="memdesc:ga75a2a4b96d3c6ab06845c6cd0e37b15d"><td class="mdescLeft"> </td><td class="mdescRight">Get the full description for all the errors which has occured in this thread since the last call of this function or <a class="el" href="group__ERRORS.html#ga460f0799ef0d3718e656525d78b3f77d">oscap_clearerr</a>. <a href="#ga75a2a4b96d3c6ab06845c6cd0e37b15d">More...</a><br/></td></tr>
<tr class="separator:ga75a2a4b96d3c6ab06845c6cd0e37b15d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
OpenSCAP error families</h2></td></tr>
<tr class="memitem:ga2a4b222f295b167554e471b040639383"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2a4b222f295b167554e471b040639383"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga2a4b222f295b167554e471b040639383">OSCAP_EFAMILY_NONE</a>   0</td></tr>
<tr class="memdesc:ga2a4b222f295b167554e471b040639383"><td class="mdescLeft"> </td><td class="mdescRight">None. <br/></td></tr>
<tr class="separator:ga2a4b222f295b167554e471b040639383"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc53d2370c80b6ed73177e50cadd9dff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacc53d2370c80b6ed73177e50cadd9dff"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gacc53d2370c80b6ed73177e50cadd9dff">OSCAP_EFAMILY_GLIBC</a>   1</td></tr>
<tr class="memdesc:gacc53d2370c80b6ed73177e50cadd9dff"><td class="mdescLeft"> </td><td class="mdescRight">Errno errors. <br/></td></tr>
<tr class="separator:gacc53d2370c80b6ed73177e50cadd9dff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c221a396c86b253134dcf2cdd8fffc6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5c221a396c86b253134dcf2cdd8fffc6"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga5c221a396c86b253134dcf2cdd8fffc6">OSCAP_EFAMILY_XML</a>   2</td></tr>
<tr class="memdesc:ga5c221a396c86b253134dcf2cdd8fffc6"><td class="mdescLeft"> </td><td class="mdescRight">Libxml errors. <br/></td></tr>
<tr class="separator:ga5c221a396c86b253134dcf2cdd8fffc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga063ef25dbff56281ad8b88bd3e5637a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga063ef25dbff56281ad8b88bd3e5637a2"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#ga063ef25dbff56281ad8b88bd3e5637a2">OSCAP_EFAMILY_OSCAP</a>   3</td></tr>
<tr class="memdesc:ga063ef25dbff56281ad8b88bd3e5637a2"><td class="mdescLeft"> </td><td class="mdescRight">OSCAP general errors. <br/></td></tr>
<tr class="separator:ga063ef25dbff56281ad8b88bd3e5637a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0e81243524424435f8099c768fd3ab3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac0e81243524424435f8099c768fd3ab3"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gac0e81243524424435f8099c768fd3ab3">OSCAP_EFAMILY_OVAL</a>   4</td></tr>
<tr class="memdesc:gac0e81243524424435f8099c768fd3ab3"><td class="mdescLeft"> </td><td class="mdescRight">OVAL errors (OVAL & probes) <br/></td></tr>
<tr class="separator:gac0e81243524424435f8099c768fd3ab3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef8f195999b3b733a1dc88b7f9bc8800"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaef8f195999b3b733a1dc88b7f9bc8800"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaef8f195999b3b733a1dc88b7f9bc8800">OSCAP_EFAMILY_XCCDF</a>   5</td></tr>
<tr class="memdesc:gaef8f195999b3b733a1dc88b7f9bc8800"><td class="mdescLeft"> </td><td class="mdescRight">XCCDF errors. <br/></td></tr>
<tr class="separator:gaef8f195999b3b733a1dc88b7f9bc8800"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae87e6b5d234f844d8493c97b279708c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae87e6b5d234f844d8493c97b279708c0"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gae87e6b5d234f844d8493c97b279708c0">OSCAP_EFAMILY_SCE</a>   6</td></tr>
<tr class="memdesc:gae87e6b5d234f844d8493c97b279708c0"><td class="mdescLeft"> </td><td class="mdescRight">SCE errors. <br/></td></tr>
<tr class="separator:gae87e6b5d234f844d8493c97b279708c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaadf5a0db08496a0bfeb408ab410be7f4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html#gaadf5a0db08496a0bfeb408ab410be7f4">OSCAP_EFAMILY_NET</a>   7</td></tr>
<tr class="memdesc:gaadf5a0db08496a0bfeb408ab410be7f4"><td class="mdescLeft"> </td><td class="mdescRight">Errors from network communication. <a href="#gaadf5a0db08496a0bfeb408ab410be7f4">More...</a><br/></td></tr>
<tr class="separator:gaadf5a0db08496a0bfeb408ab410be7f4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Error checking mechanism. </p>
<p>Purse of this mechanism is to inform user about problems that occured during executaion of library functions. Mechanism is similar to linux errno variable. When the problem raise, the information about it is stored in library buffer. This information consists of error family, and textual description. Example of usage:</p>
<div class="fragment"><div class="line">syschar = oval_probe_object_eval (pctx, <span class="keywordtype">object</span>);</div>
<div class="line"><span class="keywordflow">if</span> (syschar == NULL && <a class="code" href="group__ERRORS.html#ga6250756dc15760ad37288410b1117433" title="Check for an error.">oscap_err</a>()) {</div>
<div class="line"> printf(<span class="stringliteral">"Error: (%d) %s\n"</span>, <a class="code" href="group__ERRORS.html#gaf5a130197519ab79f452a592c327c89b" title="Get last error family.">oscap_err_family</a>(), <a class="code" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f" title="Get last error description.">oscap_err_desc</a>());</div>
<div class="line">}</div>
<div class="line"><a class="code" href="group__ERRORS.html#ga460f0799ef0d3718e656525d78b3f77d" title="Clear an error.">oscap_clearerr</a>()</div>
</div><!-- fragment --> <h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaadf5a0db08496a0bfeb408ab410be7f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_EFAMILY_NET   7</td>
</tr>
</table>
</div><div class="memdoc">
<p>Errors from network communication. </p>
<p>Presumably from libcurl. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga75a2a4b96d3c6ab06845c6cd0e37b15d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* oscap_err_get_full_error </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the full description for all the errors which has occured in this thread since the last call of this function or <a class="el" href="group__ERRORS.html#ga460f0799ef0d3718e656525d78b3f77d">oscap_clearerr</a>. </p>
<p>This function is destructive. Subsequent call shall return NULL. </p>
<dl class="section return"><dt>Returns</dt><dd>zero terminated string describing these errors, which shall be disposed by caller. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>if there are no errors. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
|
