<!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: Library-side probe interface</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.7.4 -->
<div id="top">
<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>
<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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Library-side probe interface</div> </div>
<div class="ingroups"><a class="el" href="group__PROBES.html">System checking mechanism - probes</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </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><a name="define-members"></a>
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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae30fafdcbfb5442c194fd9ad32804a4f">OVAL_PDFLAG_NOREPLY</a>   0x0001</td></tr>
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae3e39bc1380b4a735823d501c33d3012">OVAL_PDFLAG_NORECONN</a>   0x0002</td></tr>
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga06e7ae75ca374bec978db0f2acd3e223">OVAL_PDGLAG_RUNALL</a>   0x0004</td></tr>
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gae12675e61c2c9724d08d2d5e443a2045">OVAL_PDFLAG_RUNNOW</a>   0x0008</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">execute all probes immediately <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0ff475c1fbfad062d2891b89dbdd2bc7"></a><!-- doxytag: member="PROBEINTERFACE::OVAL_PDFLAG_SLAVE" ref="ga0ff475c1fbfad062d2891b89dbdd2bc7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>OVAL_PDFLAG_SLAVE</b>   0x0010</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 </td><td class="memItemRight" valign="bottom"><b>OVAL_PDFLAG_MASK</b>   (0x0001|0x0002|0x0004|0x0008|0x0010)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
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 * </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> </td><td class="memItemRight" valign="bottom"><b>oval_str2subtype</b> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga439faf604e78df6b6c9a68fefea504c7">oval_probe_query_sysinfo</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, struct <a class="el" href="structoval__sysinfo.html">oval_sysinfo</a> **out_sysinfo) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Evaluate system info probe. <a href="#ga439faf604e78df6b6c9a68fefea504c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#gab34c0e570f0b4ffdafc6c5c0719d6392">oval_probe_query_object</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *psess, struct <a class="el" href="structoval__object.html">oval_object</a> *object, int flags, struct <a class="el" href="structoval__syschar.html">oval_syschar</a> **out_syschar) <a class="el" href="struct____attribute____.html">__attribute__</a>((nonnull(1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Evaluate an object. <a href="#gab34c0e570f0b4ffdafc6c5c0719d6392"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int int int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga5f2981a955e19405361ddcf450975662">oval_probe_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"> </td><td class="mdescRight">Probe objects required for the evalatuation of the specified definition and update the system characteristics model associated with the session. <a href="#ga5f2981a955e19405361ddcf450975662"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int int int int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBEINTERFACE.html#ga940cd2f7a3ee533cda290f56c4008cd8">oval_probe_query_variable</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, struct <a class="el" href="structoval__variable.html">oval_variable</a> *variable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the specified variable and all its dependencies in order to compute the vector of its values. <a href="#ga940cd2f7a3ee533cda290f56c4008cd8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
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 * </td><td class="memItemRight" valign="bottom"><b>oval_subtypedsc_t::name</b></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga5f2981a955e19405361ddcf450975662"></a><!-- doxytag: member="oval_probe.h::oval_probe_query_definition" ref="ga5f2981a955e19405361ddcf450975662" 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 int int oval_probe_query_definition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Probe objects required for the evalatuation of the specified definition and update the system characteristics model associated with the session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>probe session </td></tr>
<tr><td class="paramname">id</td><td>definition id </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; -1 on error; 1 warning </dd></dl>
</div>
</div>
<a class="anchor" id="gab34c0e570f0b4ffdafc6c5c0719d6392"></a><!-- doxytag: member="oval_probe.h::oval_probe_query_object" ref="gab34c0e570f0b4ffdafc6c5c0719d6392" args="(oval_probe_session_t *psess, struct oval_object *object, int flags, struct oval_syschar **out_syschar) __attribute__((nonnull(1" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int int oval_probe_query_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>psess</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structoval__object.html">oval_object</a> * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structoval__syschar.html">oval_syschar</a> ** </td>
<td class="paramname"><em>out_syschar</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Evaluate an object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>probe session </td></tr>
<tr><td class="paramname">object</td><td>the object to evaluate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga439faf604e78df6b6c9a68fefea504c7"></a><!-- doxytag: member="oval_probe.h::oval_probe_query_sysinfo" ref="ga439faf604e78df6b6c9a68fefea504c7" args="(oval_probe_session_t *sess, struct oval_sysinfo **out_sysinfo) __attribute__((nonnull(1" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_probe_query_sysinfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </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__sysinfo.html">oval_sysinfo</a> ** </td>
<td class="paramname"><em>out_sysinfo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Evaluate system info probe. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>probe session </td></tr>
<tr><td class="paramname">out_sysinfo</td><td>address of a pointer to hold the result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga940cd2f7a3ee533cda290f56c4008cd8"></a><!-- doxytag: member="oval_probe.h::oval_probe_query_variable" ref="ga940cd2f7a3ee533cda290f56c4008cd8" args="(oval_probe_session_t *sess, struct oval_variable *variable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int int int int oval_probe_query_variable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </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__variable.html">oval_variable</a> * </td>
<td class="paramname"><em>variable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the specified variable and all its dependencies in order to compute the vector of its values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>probe session </td></tr>
<tr><td class="paramname">variable</td><td>the variable to query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
