| Current File : //usr/share/docs/openscap/html/structxccdf__policy__engine.html |
<!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.9.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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">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> </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"> </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"> </td></tr>
<tr class="memitem:ae8203e9a3fdf691825db7fa5246b1b60"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </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"> </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"> </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 * </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"> </td><td class="mdescRight">Identificator of checking engine. <br /></td></tr>
<tr class="separator:aea39d9be4bc535344aa6d2d119799734"><td class="memSeparator" colspan="2"> </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#ga41798c84b8978d4c9dd7aea32e0acf58">xccdf_policy_engine_eval_fn</a> </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"> </td><td class="mdescRight">format of callback function <br /></td></tr>
<tr class="separator:a8199800cda38400fcf498a68a3bc01cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b5d4b9aa5ad8c580385f02bb38db192"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b5d4b9aa5ad8c580385f02bb38db192"></a>
void * </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"> </td><td class="mdescRight">User data structure. <br /></td></tr>
<tr class="separator:a3b5d4b9aa5ad8c580385f02bb38db192"><td class="memSeparator" colspan="2"> </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#ga130580709fde38e26322bd157616e5a0">xccdf_policy_engine_query_fn</a> </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"> </td><td class="mdescRight">query callback function <br /></td></tr>
<tr class="separator:a69c8083f260d4ba5b5f1f41611e89ea1"><td class="memSeparator" colspan="2"> </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> * </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> * </td>
<td class="paramname"><em>policy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>definition_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </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> * </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> * </td>
<td class="paramname"><em>check_import_it</em> </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="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> * </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> </td>
<td class="paramname"><em>query_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>query_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>