File: structxccdf__policy__engine.html

package info (click to toggle)
openscap 1.0.9-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 129,588 kB
  • ctags: 26,325
  • sloc: xml: 611,156; ansic: 90,367; sh: 26,693; makefile: 2,463; python: 804; perl: 445; cpp: 123
file content (211 lines) | stat: -rw-r--r-- 12,172 bytes parent folder | download
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
<!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: xccdf_policy_engine 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">xccdf_policy_engine 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:a45150706fcbca5a42cb2071feb331bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#a45150706fcbca5a42cb2071feb331bf1">xccdf_policy_engine_eval</a> (struct <a class="el" href="structxccdf__policy__engine.html">xccdf_policy_engine</a> *engine, struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *definition_id, const char *href_id, struct <a class="el" href="structoscap__list.html">oscap_list</a> *value_bindings, struct <a class="el" href="structxccdf__check__import__iterator.html">xccdf_check_import_iterator</a> *check_import_it)</td></tr>
<tr class="memdesc:a45150706fcbca5a42cb2071feb331bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the eval function of the given checking engine.  <a href="#a45150706fcbca5a42cb2071feb331bf1">More...</a><br/></td></tr>
<tr class="separator:a45150706fcbca5a42cb2071feb331bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8203e9a3fdf691825db7fa5246b1b60"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#ae8203e9a3fdf691825db7fa5246b1b60">xccdf_policy_engine_query</a> (struct <a class="el" href="structxccdf__policy__engine.html">xccdf_policy_engine</a> *engine, <a class="el" href="group__XCCDF__POLICY.html#ga74d0efa085633f92a2421580786aca01">xccdf_policy_engine_query_t</a> query_type, void *query_data)</td></tr>
<tr class="memdesc:ae8203e9a3fdf691825db7fa5246b1b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the query function of the given checking engine.  <a href="#ae8203e9a3fdf691825db7fa5246b1b60">More...</a><br/></td></tr>
<tr class="separator:ae8203e9a3fdf691825db7fa5246b1b60"><td class="memSeparator" colspan="2">&#160;</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:aea39d9be4bc535344aa6d2d119799734"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea39d9be4bc535344aa6d2d119799734"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#aea39d9be4bc535344aa6d2d119799734">system</a></td></tr>
<tr class="memdesc:aea39d9be4bc535344aa6d2d119799734"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identificator of checking engine. <br/></td></tr>
<tr class="separator:aea39d9be4bc535344aa6d2d119799734"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8199800cda38400fcf498a68a3bc01cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8199800cda38400fcf498a68a3bc01cd"></a>
<a class="el" href="group__XCCDF__POLICY.html#ga322816631128d9e1e513441b0d87a9c4">xccdf_policy_engine_eval_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#a8199800cda38400fcf498a68a3bc01cd">callback</a></td></tr>
<tr class="memdesc:a8199800cda38400fcf498a68a3bc01cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">format of callback function <br/></td></tr>
<tr class="separator:a8199800cda38400fcf498a68a3bc01cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b5d4b9aa5ad8c580385f02bb38db192"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b5d4b9aa5ad8c580385f02bb38db192"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#a3b5d4b9aa5ad8c580385f02bb38db192">usr</a></td></tr>
<tr class="memdesc:a3b5d4b9aa5ad8c580385f02bb38db192"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data structure. <br/></td></tr>
<tr class="separator:a3b5d4b9aa5ad8c580385f02bb38db192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69c8083f260d4ba5b5f1f41611e89ea1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69c8083f260d4ba5b5f1f41611e89ea1"></a>
<a class="el" href="group__XCCDF__POLICY.html#ga4943da55034c7b10b86826fe968571a8">xccdf_policy_engine_query_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxccdf__policy__engine.html#a69c8083f260d4ba5b5f1f41611e89ea1">query_fn</a></td></tr>
<tr class="memdesc:a69c8083f260d4ba5b5f1f41611e89ea1"><td class="mdescLeft">&#160;</td><td class="mdescRight">query callback function <br/></td></tr>
<tr class="separator:a69c8083f260d4ba5b5f1f41611e89ea1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a45150706fcbca5a42cb2071feb331bf1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> xccdf_policy_engine_eval </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxccdf__policy__engine.html">xccdf_policy_engine</a> *&#160;</td>
          <td class="paramname"><em>engine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *&#160;</td>
          <td class="paramname"><em>policy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>definition_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>href_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structoscap__list.html">oscap_list</a> *&#160;</td>
          <td class="paramname"><em>value_bindings</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structxccdf__check__import__iterator.html">xccdf_check_import_iterator</a> *&#160;</td>
          <td class="paramname"><em>check_import_it</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Execute the eval function of the given checking engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">engine</td><td>Checking engine </td></tr>
    <tr><td class="paramname">policy</td><td>XCCDF Policy </td></tr>
    <tr><td class="paramname">definition_id</td><td>ID of definition to evaluate </td></tr>
    <tr><td class="paramname">href_id</td><td>The  attribute of check-content-ref </td></tr>
    <tr><td class="paramname">value_bindings</td><td>Value binding </td></tr>
    <tr><td class="paramname">check_import_it</td><td>Check imports </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>result of checking engine evaluation </dd></dl>

</div>
</div>
<a class="anchor" id="ae8203e9a3fdf691825db7fa5246b1b60"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * xccdf_policy_engine_query </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxccdf__policy__engine.html">xccdf_policy_engine</a> *&#160;</td>
          <td class="paramname"><em>engine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__XCCDF__POLICY.html#ga74d0efa085633f92a2421580786aca01">xccdf_policy_engine_query_t</a>&#160;</td>
          <td class="paramname"><em>query_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>query_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Execute the query function of the given checking engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">engine</td><td>Checking Engine </td></tr>
    <tr><td class="paramname">query_type</td><td>Type of a query over checking engine data. </td></tr>
    <tr><td class="paramname">query_data</td><td>Additional data for the checking engine query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>list of query results </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>xccdf_policy_engine.c</li>
<li><a class="el" href="xccdf__policy__engine__priv_8h_source.html">xccdf_policy_engine_priv.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>