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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<!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: sce_check_result Struct Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">sce_check_result Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af88b8ec84aaef0c91b9abae02125deb4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af88b8ec84aaef0c91b9abae02125deb4"></a>
struct <a class="el" href="structsce__check__result.html">sce_check_result</a> * </td><td class="memItemRight" valign="bottom"><b>sce_check_result_new</b> (void)</td></tr>
<tr class="separator:af88b8ec84aaef0c91b9abae02125deb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9711d43e30605274b6346aaa55be867c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9711d43e30605274b6346aaa55be867c"></a>
void </td><td class="memItemRight" valign="bottom"><b>sce_check_result_free</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:a9711d43e30605274b6346aaa55be867c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0f2c197d7871a868996d5b336b5a31c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0f2c197d7871a868996d5b336b5a31c"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#ad0f2c197d7871a868996d5b336b5a31c">sce_check_result_set_href</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, const char *href)</td></tr>
<tr class="memdesc:ad0f2c197d7871a868996d5b336b5a31c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the href used to execute the check that yielded given check result. <br/></td></tr>
<tr class="separator:ad0f2c197d7871a868996d5b336b5a31c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a766fed14ca47e4e2a60932d0b8a54bd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a766fed14ca47e4e2a60932d0b8a54bd1"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>sce_check_result_get_href</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:a766fed14ca47e4e2a60932d0b8a54bd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad706ee9cad5195e87a9304ca3a21145d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad706ee9cad5195e87a9304ca3a21145d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#ad706ee9cad5195e87a9304ca3a21145d">sce_check_result_set_basename</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, const char *basename)</td></tr>
<tr class="memdesc:ad706ee9cad5195e87a9304ca3a21145d"><td class="mdescLeft"> </td><td class="mdescRight">Sets basename of the script that was used for check evaluation. <br/></td></tr>
<tr class="separator:ad706ee9cad5195e87a9304ca3a21145d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ff59ff7257e9db362b0d6d8c6cde0f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ff59ff7257e9db362b0d6d8c6cde0f5"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>sce_check_result_get_basename</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:a3ff59ff7257e9db362b0d6d8c6cde0f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2ced7f2fcb4771181591fe61380468a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#ad2ced7f2fcb4771181591fe61380468a">sce_check_result_set_stdout</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, const char *details)</td></tr>
<tr class="memdesc:ad2ced7f2fcb4771181591fe61380468a"><td class="mdescLeft"> </td><td class="mdescRight">Sets stdout that was captured while script was evaluating. <a href="#ad2ced7f2fcb4771181591fe61380468a">More...</a><br/></td></tr>
<tr class="separator:ad2ced7f2fcb4771181591fe61380468a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e126bf61e3e91356b5bf0e94ebcefa4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e126bf61e3e91356b5bf0e94ebcefa4"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>sce_check_result_get_stdout</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:a0e126bf61e3e91356b5bf0e94ebcefa4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92496bb53bf6de30b7f5daac054bea46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92496bb53bf6de30b7f5daac054bea46"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#a92496bb53bf6de30b7f5daac054bea46">sce_check_result_set_exit_code</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, int exit_code)</td></tr>
<tr class="memdesc:a92496bb53bf6de30b7f5daac054bea46"><td class="mdescLeft"> </td><td class="mdescRight">Sets exit code with which the script ended execution after evaluation. <br/></td></tr>
<tr class="separator:a92496bb53bf6de30b7f5daac054bea46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8e2b97a9c8b580bacd553d4b8f956f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8e2b97a9c8b580bacd553d4b8f956f8"></a>
int </td><td class="memItemRight" valign="bottom"><b>sce_check_result_get_exit_code</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:ad8e2b97a9c8b580bacd553d4b8f956f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a527899bc859f036c7fa9788af378d585"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a527899bc859f036c7fa9788af378d585"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#a527899bc859f036c7fa9788af378d585">sce_check_result_reset_environment_variables</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="memdesc:a527899bc859f036c7fa9788af378d585"><td class="mdescLeft"> </td><td class="mdescRight">Clears the list of passed environment variables. <br/></td></tr>
<tr class="separator:a527899bc859f036c7fa9788af378d585"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25cb6feea6c0173dc485936481c9d6a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#a25cb6feea6c0173dc485936481c9d6a0">sce_check_result_add_environment_variable</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, const char *var)</td></tr>
<tr class="memdesc:a25cb6feea6c0173dc485936481c9d6a0"><td class="mdescLeft"> </td><td class="mdescRight">Adds an environment variable entry to list of environment variables that were passed to the script. <a href="#a25cb6feea6c0173dc485936481c9d6a0">More...</a><br/></td></tr>
<tr class="separator:a25cb6feea6c0173dc485936481c9d6a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9dacd04a46932e19506a664ab0352301"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dacd04a46932e19506a664ab0352301"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#a9dacd04a46932e19506a664ab0352301">sce_check_result_set_xccdf_result</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, <a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> result)</td></tr>
<tr class="memdesc:a9dacd04a46932e19506a664ab0352301"><td class="mdescLeft"> </td><td class="mdescRight">Sets the final xccdf result (after exit code to xccdf mapping takes place) <br/></td></tr>
<tr class="separator:a9dacd04a46932e19506a664ab0352301"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24edb08e998770a748fc31f76a440698"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24edb08e998770a748fc31f76a440698"></a>
<a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> </td><td class="memItemRight" valign="bottom"><b>sce_check_result_get_xccdf_result</b> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v)</td></tr>
<tr class="separator:a24edb08e998770a748fc31f76a440698"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afad4a0ba0f1226aff6fb6308676b36fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afad4a0ba0f1226aff6fb6308676b36fe"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsce__check__result.html#afad4a0ba0f1226aff6fb6308676b36fe">sce_check_result_export</a> (struct <a class="el" href="structsce__check__result.html">sce_check_result</a> *v, const char *target_file)</td></tr>
<tr class="memdesc:afad4a0ba0f1226aff6fb6308676b36fe"><td class="mdescLeft"> </td><td class="mdescRight">Exports details (in XML form) of given check result to given file. <br/></td></tr>
<tr class="separator:afad4a0ba0f1226aff6fb6308676b36fe"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a973cd3c41f64db0024c9b18ee2cfa0f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a973cd3c41f64db0024c9b18ee2cfa0f1"></a>
char * </td><td class="memItemRight" valign="bottom"><b>href</b></td></tr>
<tr class="separator:a973cd3c41f64db0024c9b18ee2cfa0f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a961f4f3fbe24388dc7062e8eb16774d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a961f4f3fbe24388dc7062e8eb16774d5"></a>
char * </td><td class="memItemRight" valign="bottom"><b>basename</b></td></tr>
<tr class="separator:a961f4f3fbe24388dc7062e8eb16774d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf5f2639292338c286bf3ed666364f51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf5f2639292338c286bf3ed666364f51"></a>
char * </td><td class="memItemRight" valign="bottom"><b>stdout</b></td></tr>
<tr class="separator:abf5f2639292338c286bf3ed666364f51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68b223fc5c86dcf8e61e688891d0b004"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68b223fc5c86dcf8e61e688891d0b004"></a>
int </td><td class="memItemRight" valign="bottom"><b>exit_code</b></td></tr>
<tr class="separator:a68b223fc5c86dcf8e61e688891d0b004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95507215a2e4587521ef0bb95eee5a9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95507215a2e4587521ef0bb95eee5a9b"></a>
struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </td><td class="memItemRight" valign="bottom"><b>environment_variables</b></td></tr>
<tr class="separator:a95507215a2e4587521ef0bb95eee5a9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae75ace8d5848f2f56c68b2109c1da62a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae75ace8d5848f2f56c68b2109c1da62a"></a>
<a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> </td><td class="memItemRight" valign="bottom"><b>xccdf_result</b></td></tr>
<tr class="separator:ae75ace8d5848f2f56c68b2109c1da62a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a25cb6feea6c0173dc485936481c9d6a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sce_check_result_add_environment_variable </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsce__check__result.html">sce_check_result</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>var</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an environment variable entry to list of environment variables that were passed to the script. </p>
<p>These include XCCDF result codes, bound XCCDF variables and possibly more.</p>
<p><a class="el" href="structsce__check__result.html">sce_check_result</a> contains these mostly for debugging purposes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">var</td><td>entry that will be added, in "VARIABLE_NAME=VARIABLE_VALUE" form </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad2ced7f2fcb4771181591fe61380468a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sce_check_result_set_stdout </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsce__check__result.html">sce_check_result</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>details</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets stdout that was captured while script was evaluating. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stdout</td><td>should contain output from both stdout and stderr (interleaved) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="sce__engine_8c.html">sce_engine.c</a></li>
<li><a class="el" href="sce__engine__api_8h_source.html">sce_engine_api.h</a></li>
</ul>
</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>
|
