File: group__PROBEINTERFACE.html

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (225 lines) | stat: -rw-r--r-- 15,213 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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<!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: PROBEINTERFACE</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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PROBEINTERFACE</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__subtypedsc__t.html">oval_subtypedsc_t</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae30fafdcbfb5442c194fd9ad32804a4f"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDFLAG_NOREPLY" ref="gae30fafdcbfb5442c194fd9ad32804a4f" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae30fafdcbfb5442c194fd9ad32804a4f">OVAL_PDFLAG_NOREPLY</a>&nbsp;&nbsp;&nbsp;0x0001</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">don't send probe result to library - just an ack <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae3e39bc1380b4a735823d501c33d3012"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDFLAG_NORECONN" ref="gae3e39bc1380b4a735823d501c33d3012" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae3e39bc1380b4a735823d501c33d3012">OVAL_PDFLAG_NORECONN</a>&nbsp;&nbsp;&nbsp;0x0002</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">don't try to reconnect on fatal errors <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga06e7ae75ca374bec978db0f2acd3e223"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDGLAG_RUNALL" ref="ga06e7ae75ca374bec978db0f2acd3e223" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga06e7ae75ca374bec978db0f2acd3e223">OVAL_PDGLAG_RUNALL</a>&nbsp;&nbsp;&nbsp;0x0004</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute all probes when executing the first <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae12675e61c2c9724d08d2d5e443a2045"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDFLAG_RUNNOW" ref="gae12675e61c2c9724d08d2d5e443a2045" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae12675e61c2c9724d08d2d5e443a2045">OVAL_PDFLAG_RUNNOW</a>&nbsp;&nbsp;&nbsp;0x0008</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute all probes immediately <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9fa5168f0dde4af115477081ff1dd44d"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDFLAG_MASK" ref="ga9fa5168f0dde4af115477081ff1dd44d" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>OVAL_PDFLAG_MASK</b>&nbsp;&nbsp;&nbsp;(0x0001|0x0002|0x0004|0x0008)</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga579c5d09d4a07abd2d7c87c89a2db404"></a><!-- doxytag: member="PROBEINTERFACE::oval_subtype2str" ref="ga579c5d09d4a07abd2d7c87c89a2db404" args="(oval_subtype_t subtype)" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>oval_subtype2str</b> (<a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> subtype)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac136e22b359e366cb7344e1a9aa3a533"></a><!-- doxytag: member="PROBEINTERFACE::oval_str2subtype" ref="gac136e22b359e366cb7344e1a9aa3a533" args="(const char *str)" -->
<a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>oval_str2subtype</b> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__sysinfo.html">oval_sysinfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga26b93a31735e0d864b3b3da88b62a265">oval_probe_sysinfo_query</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1)))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate system info probe.  <a href="#ga26b93a31735e0d864b3b3da88b62a265"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga7820b6a71d1ea7ad970a5de5b4d405f4">oval_probe_object_query</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, struct <a class="el" href="structoval__object.html">oval_object</a> *object, int flags) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate an object.  <a href="#ga7820b6a71d1ea7ad970a5de5b4d405f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga59f993a1fbe1fea71545745e55aba742">oval_probe_session_query_sysinfo</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1)))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Probe system info and update system characteristic model in the session.  <a href="#ga59f993a1fbe1fea71545745e55aba742"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga7a8949e9fa2c6e5ca157d6c8c3e8f30f">oval_probe_session_query_objects</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1)))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Probe all objects and update system characteristic model in the session.  <a href="#ga7a8949e9fa2c6e5ca157d6c8c3e8f30f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga8f6eb359b739aa63173e768110d73d96">oval_probe_session_query_definition</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, const char *id) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Probe objects required for evalatuation specified definition and update system characteristic model in the session.  <a href="#ga8f6eb359b739aa63173e768110d73d96"></a><br/></td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga97c947025c9b218c91389467fe1fad9c"></a><!-- doxytag: member="PROBEINTERFACE::name" ref="ga97c947025c9b218c91389467fe1fad9c" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>oval_subtypedsc_t::name</b></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7820b6a71d1ea7ad970a5de5b4d405f4"></a><!-- doxytag: member="oval_probe.h::oval_probe_object_query" ref="ga7820b6a71d1ea7ad970a5de5b4d405f4" args="(oval_probe_session_t *sess, struct oval_object *object, int flags) __attribute__((nonnull(1" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structoval__syschar.html">oval_syschar</a>* oval_probe_object_query </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structoval__object.html">oval_object</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>flags</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Evaluate an object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>probe session </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>the object to evaluate </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga8f6eb359b739aa63173e768110d73d96"></a><!-- doxytag: member="oval_probe.h::oval_probe_session_query_definition" ref="ga8f6eb359b739aa63173e768110d73d96" args="(oval_probe_session_t *sess, const char *id) __attribute__((nonnull(1" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int oval_probe_session_query_definition </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Probe objects required for evalatuation specified definition and update system characteristic model in the session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>probe session </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>definition id </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success </dd></dl>

</div>
</div>
<a class="anchor" id="ga7a8949e9fa2c6e5ca157d6c8c3e8f30f"></a><!-- doxytag: member="oval_probe.h::oval_probe_session_query_objects" ref="ga7a8949e9fa2c6e5ca157d6c8c3e8f30f" args="(oval_probe_session_t *sess) __attribute__((nonnull(1)))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int oval_probe_session_query_objects </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Probe all objects and update system characteristic model in the session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>probe session </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success </dd></dl>

</div>
</div>
<a class="anchor" id="ga59f993a1fbe1fea71545745e55aba742"></a><!-- doxytag: member="oval_probe.h::oval_probe_session_query_sysinfo" ref="ga59f993a1fbe1fea71545745e55aba742" args="(oval_probe_session_t *sess) __attribute__((nonnull(1)))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structoval__syschar.html">oval_syschar</a>* int oval_probe_session_query_sysinfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Probe system info and update system characteristic model in the session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>probe session </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success </dd></dl>

</div>
</div>
<a class="anchor" id="ga26b93a31735e0d864b3b3da88b62a265"></a><!-- doxytag: member="oval_probe.h::oval_probe_sysinfo_query" ref="ga26b93a31735e0d864b3b3da88b62a265" args="(oval_probe_session_t *sess) __attribute__((nonnull(1)))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structoval__sysinfo.html">oval_sysinfo</a>* oval_probe_sysinfo_query </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Evaluate system info probe. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>probe session </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>