| Current File : //usr/share/docs/openscap/html/group__OVALDIR.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: OVALDIR</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><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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#files">Files</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">OVALDIR<div class="ingroups"><a class="el" href="group__OVAL.html">OVAL</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for Directives model.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:oval__directives_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="oval__directives_8h.html">oval_directives.h</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__directives__model.html">oval_directives_model</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds instance of OVAL Directives. <a href="structoval__directives__model.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__result__directives.html">oval_result_directives</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds instance of either OVAL Default Directives or OVAL Class directives. <a href="structoval__result__directives.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga9e7b5741bebbe68b5ddf76e4042125a6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#ga9e7b5741bebbe68b5ddf76e4042125a6">oval_result_directive_content_t</a> { <a class="el" href="group__OVALDIR.html#gga9e7b5741bebbe68b5ddf76e4042125a6abca9d283da03a9abad280a9c0db2439d">OVAL_DIRECTIVE_CONTENT_UNKNOWN</a> = 0,
<a class="el" href="group__OVALDIR.html#gga9e7b5741bebbe68b5ddf76e4042125a6a3262af729be4d4b26cace264eed8327c">OVAL_DIRECTIVE_CONTENT_THIN</a> = 1,
<a class="el" href="group__OVALDIR.html#gga9e7b5741bebbe68b5ddf76e4042125a6ab4317315755aaf265b9cebb5fef5fbae">OVAL_DIRECTIVE_CONTENT_FULL</a> = 2
}</td></tr>
<tr class="memdesc:ga9e7b5741bebbe68b5ddf76e4042125a6"><td class="mdescLeft"> </td><td class="mdescRight">Values for the directives controlling the expected content of the results file. <a href="group__OVALDIR.html#ga9e7b5741bebbe68b5ddf76e4042125a6">More...</a><br /></td></tr>
<tr class="separator:ga9e7b5741bebbe68b5ddf76e4042125a6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadafbf570922981a747800807359e3f35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadafbf570922981a747800807359e3f35"></a>
struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> * </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_new</b> (void)</td></tr>
<tr class="separator:gadafbf570922981a747800807359e3f35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae86939f291aa455b8963ca79b0ee4b6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae86939f291aa455b8963ca79b0ee4b6d"></a>
void </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_free</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *)</td></tr>
<tr class="separator:gae86939f291aa455b8963ca79b0ee4b6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2e774b81b0363816b81e9c1b4be48c5c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2e774b81b0363816b81e9c1b4be48c5c"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#ga2e774b81b0363816b81e9c1b4be48c5c">oval_directives_model::oval_directives_model_import_source</a> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *model, struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:ga2e774b81b0363816b81e9c1b4be48c5c"><td class="mdescLeft"> </td><td class="mdescRight">Import the data from <a class="el" href="structoscap__source.html">oscap_source</a> to the directives model. <br /></td></tr>
<tr class="separator:ga2e774b81b0363816b81e9c1b4be48c5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1f42990d182bf85ae2f63e731d0857b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#gae1f42990d182bf85ae2f63e731d0857b">oval_directives_model::oval_directives_model_import</a> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *, char *)</td></tr>
<tr class="separator:gae1f42990d182bf85ae2f63e731d0857b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga329adfce64405edbb3a9b5a904d24f57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga329adfce64405edbb3a9b5a904d24f57"></a>
struct <a class="el" href="structoval__generator.html">oval_generator</a> * </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_get_generator</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *)</td></tr>
<tr class="separator:ga329adfce64405edbb3a9b5a904d24f57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafcb47a768091becb11c7d4578173b1b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafcb47a768091becb11c7d4578173b1b5"></a>
struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_get_defdirs</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *)</td></tr>
<tr class="separator:gafcb47a768091becb11c7d4578173b1b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03f83d52b9161a5a05be7c95f32e0c84"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga03f83d52b9161a5a05be7c95f32e0c84"></a>
struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_get_classdir</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *, <a class="el" href="oval__types_8h.html#a3323efc68980168d0187c26dd22bfce1">oval_definition_class_t</a>)</td></tr>
<tr class="separator:ga03f83d52b9161a5a05be7c95f32e0c84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga88c97384ce3611366a5793f657460a7f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga88c97384ce3611366a5793f657460a7f"></a>
struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_get_new_classdir</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *, <a class="el" href="oval__types_8h.html#a3323efc68980168d0187c26dd22bfce1">oval_definition_class_t</a>)</td></tr>
<tr class="separator:ga88c97384ce3611366a5793f657460a7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadfce54c1999897d8ddf9d2a2430b1d05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadfce54c1999897d8ddf9d2a2430b1d05"></a>
int </td><td class="memItemRight" valign="bottom"><b>oval_directives_model::oval_directives_model_export</b> (struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> *, const char *)</td></tr>
<tr class="separator:gadfce54c1999897d8ddf9d2a2430b1d05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga553a30c655abea51b92e296c64f47232"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#ga553a30c655abea51b92e296c64f47232">oval_result_directives::oval_result_directives_new</a> (void)</td></tr>
<tr class="memdesc:ga553a30c655abea51b92e296c64f47232"><td class="mdescLeft"> </td><td class="mdescRight">Create new OVAL Results Directives instance. <a href="#ga553a30c655abea51b92e296c64f47232">More...</a><br /></td></tr>
<tr class="separator:ga553a30c655abea51b92e296c64f47232"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga139e240998f31ebd850d2cc61e684347"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga139e240998f31ebd850d2cc61e684347"></a>
void </td><td class="memItemRight" valign="bottom"><b>oval_result_directives::oval_result_directives_free</b> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *)</td></tr>
<tr class="separator:ga139e240998f31ebd850d2cc61e684347"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae77676bc8c7222444bd6e437aa2fc5c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#gae77676bc8c7222444bd6e437aa2fc5c8">oval_result_directives::oval_result_directives_set_reported</a> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *, int flag, bool val)</td></tr>
<tr class="memdesc:gae77676bc8c7222444bd6e437aa2fc5c8"><td class="mdescLeft"> </td><td class="mdescRight">Set (or unset) result types that are intended to be reported. <a href="#gae77676bc8c7222444bd6e437aa2fc5c8">More...</a><br /></td></tr>
<tr class="separator:gae77676bc8c7222444bd6e437aa2fc5c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a6b521f450516ca0c7e6b2dd51dc3be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8a6b521f450516ca0c7e6b2dd51dc3be"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDIR.html#ga8a6b521f450516ca0c7e6b2dd51dc3be">oval_result_directives::oval_result_directives_set_content</a> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *, int flag, <a class="el" href="group__OVALDIR.html#ga9e7b5741bebbe68b5ddf76e4042125a6">oval_result_directive_content_t</a>)</td></tr>
<tr class="memdesc:ga8a6b521f450516ca0c7e6b2dd51dc3be"><td class="mdescLeft"> </td><td class="mdescRight">Configure the depth of infomation. <br /></td></tr>
<tr class="separator:ga8a6b521f450516ca0c7e6b2dd51dc3be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab6e41a35959d2258df68c2b725393ae9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab6e41a35959d2258df68c2b725393ae9"></a>
void </td><td class="memItemRight" valign="bottom"><b>oval_result_directives::oval_result_directives_set_included</b> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *, bool)</td></tr>
<tr class="separator:gab6e41a35959d2258df68c2b725393ae9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b7984f782d06f4e3afbb15da5e370fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b7984f782d06f4e3afbb15da5e370fd"></a>
bool </td><td class="memItemRight" valign="bottom"><b>oval_result_directives::oval_result_directives_get_reported</b> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *, <a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a>)</td></tr>
<tr class="separator:ga8b7984f782d06f4e3afbb15da5e370fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1061e6dd46abb72afa0874637becf49d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1061e6dd46abb72afa0874637becf49d"></a>
bool </td><td class="memItemRight" valign="bottom"><b>oval_result_directives::oval_result_directives_get_included</b> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *)</td></tr>
<tr class="separator:ga1061e6dd46abb72afa0874637becf49d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f4f582e7347de9d92d2e540a4c4ad93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1f4f582e7347de9d92d2e540a4c4ad93"></a>
<a class="el" href="group__OVALDIR.html#ga9e7b5741bebbe68b5ddf76e4042125a6">oval_result_directive_content_t</a> </td><td class="memItemRight" valign="bottom"><b>oval_result_directives::oval_result_directives_get_content</b> (struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> *, <a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a>)</td></tr>
<tr class="separator:ga1f4f582e7347de9d92d2e540a4c4ad93"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Interface for Directives model. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga9e7b5741bebbe68b5ddf76e4042125a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__OVALDIR.html#ga9e7b5741bebbe68b5ddf76e4042125a6">oval_result_directive_content_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Values for the directives controlling the expected content of the results file. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga9e7b5741bebbe68b5ddf76e4042125a6abca9d283da03a9abad280a9c0db2439d"></a>OVAL_DIRECTIVE_CONTENT_UNKNOWN </td><td class="fielddoc">
<p>Undefined value. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga9e7b5741bebbe68b5ddf76e4042125a6a3262af729be4d4b26cace264eed8327c"></a>OVAL_DIRECTIVE_CONTENT_THIN </td><td class="fielddoc">
<p>Only the minimal amount of information will be provided. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga9e7b5741bebbe68b5ddf76e4042125a6ab4317315755aaf265b9cebb5fef5fbae"></a>OVAL_DIRECTIVE_CONTENT_FULL </td><td class="fielddoc">
<p>Very detailed information will be provided allowing in-depth reports to be generated from the results. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gae1f42990d182bf85ae2f63e731d0857b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_directives_model_import </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__directives__model.html">oval_directives_model</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000021">Deprecated:</a></b></dt><dd>This function has been deprecated and it may be dropped from later OpenSCAP releases. Please use oval_directives_model_import_source instead. </dd></dl>
</div>
</div>
<a class="anchor" id="ga553a30c655abea51b92e296c64f47232"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * oval_result_directives_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new OVAL Results Directives instance. </p>
<p>Directives are setup to report FULL result by default. </p>
</div>
</div>
<a class="anchor" id="gae77676bc8c7222444bd6e437aa2fc5c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_result_directives_set_reported </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__result__directives.html">oval_result_directives</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set (or unset) result types that are intended to be reported. </p>
<p>Functions does not override previous settings. </p>
</div>
</div>
</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>