<!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"/>
<title>Open SCAP Library: oval_agent_api.h Source File</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.1.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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_dec16e0beb5f79ab6b40e328203e2e32.html">OVAL</a></li><li class="navelem"><a class="el" href="dir_d7d4c5e9309fab4992a34dcb057ec544.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">oval_agent_api.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="oval__agent__api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Copyright 2009,2010 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifndef OVAL_AGENT_API_H_</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#define OVAL_AGENT_API_H_</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="oval__definitions_8h.html">oval_definitions.h</a>"</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include "<a class="code" href="oval__system__characteristics_8h.html">oval_system_characteristics.h</a>"</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "<a class="code" href="oval__results_8h.html">oval_results.h</a>"</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "<a class="code" href="oval__variables_8h.html">oval_variables.h</a>"</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "<a class="code" href="oval__probe_8h.html" title="OVAL probe interface API public header.">oval_probe.h</a>"</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016"> 53</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a> <a class="code" href="structoval__agent__session.html">oval_agent_session_t</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * <a class="code" href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934" title="Create new session for OVAL agent from OVAL definition model.">oval_agent_new_session</a>(<span class="keyword">struct</span> <a class="code" href="structoval__definition__model.html" title="Oval definition model.">oval_definition_model</a> * model, <span class="keyword">const</span> <span class="keywordtype">char</span> * name);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">struct </span><a class="code" href="structoval__definition__model.html" title="Oval definition model.">oval_definition_model</a>* <a class="code" href="group__OVALAGENT.html#ga5356ae518e8f7944d7c4e4a4d6320c79" title="Retrieves OVAL definition model associated with given session.">oval_agent_get_definition_model</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a>* ag_sess);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#ga4c6cd8133b213a14271d61c1058801c8" title="Set a product name for the provided agent session.">oval_agent_set_product_name</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *, <span class="keywordtype">char</span> *);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab" title="Probe the system and evaluate specified definition.">oval_agent_eval_definition</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d" title="Get the OVAL result of a definition from an agent session.">oval_agent_get_definition_result</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *, <a class="code" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf" title="Result values for the evaluation of an OVAL Definition or an OVAL Test.">oval_result_t</a> *);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">struct </span><a class="code" href="structoval__result__definition.html">oval_result_definition</a> * <a class="code" href="group__OVALAGENT.html#ga59b66b81fe4d2aedfe1255420fab709a" title="Get the OVAL result definition from an agent session.">oval_agent_get_result_definition</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga1b0b775e52aff1452ff4423f897c5825" title="Clean resuls that were generated in this agent session.">oval_agent_reset_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga7b465c077aa0ade17135dc1826b4465c" title="Abort a running probe session.">oval_agent_abort_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">typedef</span> int (*agent_reporter)(<span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="structoval__result__definition.html">oval_result_definition</a> * res_def, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga4e56e46262872dea08c12cf9fdf10d74" title="Probe and evaluate all definitions from the content, call the callback functions upon single evaluati...">oval_agent_eval_system</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess, agent_reporter cb, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">struct </span><a class="code" href="structoval__results__model.html" title="OVAL Results Model holds OVAL results structure instances.">oval_results_model</a> * <a class="code" href="group__OVALAGENT.html#ga46b7afeb2b281141e4722f219a7a438a" title="Get a result model from agent session.">oval_agent_get_results_model</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="group__OVALAGENT.html#ga891f69cec678e572518603f482e54877" title="Get a filename under which was created.">oval_agent_get_filename</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#ga301f466948c1844837208f917b3e2025" title="Finish OVAL agent session.">oval_agent_destroy_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif </span></div>
</div><!-- fragment --></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.1.1
</small></address>
</body>
</html>
