| Current File : //usr/share/docs/openscap/html/group__OVALSESSION.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: OVALSESSION</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">OVALSESSION<div class="ingroups"><a class="el" href="group__OVAL.html">OVAL</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>OVAL Session.
<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__session_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="oval__session_8h.html">oval_session.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__session.html">oval_session</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A structure encapsulating the context of OVAL operations. <a href="structoval__session.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga13fa3e11919545b7ba86c1e26fdbc7d3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__session.html">oval_session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga13fa3e11919545b7ba86c1e26fdbc7d3">oval_session::oval_session_new</a> (const char *filename)</td></tr>
<tr class="memdesc:ga13fa3e11919545b7ba86c1e26fdbc7d3"><td class="mdescLeft"> </td><td class="mdescRight">Costructor of an <a class="el" href="structoval__session.html">oval_session</a>. <a href="#ga13fa3e11919545b7ba86c1e26fdbc7d3">More...</a><br /></td></tr>
<tr class="separator:ga13fa3e11919545b7ba86c1e26fdbc7d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27c4c63cf1bbb59f91a7773723074105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga27c4c63cf1bbb59f91a7773723074105">oval_session::oval_session_set_variables</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *filename)</td></tr>
<tr class="memdesc:ga27c4c63cf1bbb59f91a7773723074105"><td class="mdescLeft"> </td><td class="mdescRight">Set OVAL Variables. <a href="#ga27c4c63cf1bbb59f91a7773723074105">More...</a><br /></td></tr>
<tr class="separator:ga27c4c63cf1bbb59f91a7773723074105"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70136bc8978a51ee0ce751d100200b19"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga70136bc8978a51ee0ce751d100200b19">oval_session::oval_session_set_directives</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *filename)</td></tr>
<tr class="memdesc:ga70136bc8978a51ee0ce751d100200b19"><td class="mdescLeft"> </td><td class="mdescRight">Set OVAL Directives. <a href="#ga70136bc8978a51ee0ce751d100200b19">More...</a><br /></td></tr>
<tr class="separator:ga70136bc8978a51ee0ce751d100200b19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga55489ebe12b237bc5a15fdfafb893d88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga55489ebe12b237bc5a15fdfafb893d88">oval_session::oval_session_set_validation</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, bool validate, bool full_validation)</td></tr>
<tr class="memdesc:ga55489ebe12b237bc5a15fdfafb893d88"><td class="mdescLeft"> </td><td class="mdescRight">Set XSD validation level. <a href="#ga55489ebe12b237bc5a15fdfafb893d88">More...</a><br /></td></tr>
<tr class="separator:ga55489ebe12b237bc5a15fdfafb893d88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0a997f4f7ad2ada20f98394485afd54"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gac0a997f4f7ad2ada20f98394485afd54">oval_session::oval_session_set_datastream_id</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *id)</td></tr>
<tr class="memdesc:gac0a997f4f7ad2ada20f98394485afd54"><td class="mdescLeft"> </td><td class="mdescRight">Set ID of a specific OVAL Definition in an source datastream. <a href="#gac0a997f4f7ad2ada20f98394485afd54">More...</a><br /></td></tr>
<tr class="separator:gac0a997f4f7ad2ada20f98394485afd54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc9e4924bbcbf3b929604c32d77d6931"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gabc9e4924bbcbf3b929604c32d77d6931">oval_session::oval_session_set_component_id</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *id)</td></tr>
<tr class="memdesc:gabc9e4924bbcbf3b929604c32d77d6931"><td class="mdescLeft"> </td><td class="mdescRight">Set ID of a particular OVAL component if there are two OVALs in one source datastream. <a href="#gabc9e4924bbcbf3b929604c32d77d6931">More...</a><br /></td></tr>
<tr class="separator:gabc9e4924bbcbf3b929604c32d77d6931"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaa45d7554ef419bab882a268fe10c49b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gaaa45d7554ef419bab882a268fe10c49b">oval_session::oval_session_set_results_export</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *filename)</td></tr>
<tr class="memdesc:gaaa45d7554ef419bab882a268fe10c49b"><td class="mdescLeft"> </td><td class="mdescRight">Set a name of the file that the the OVAL Results will be written into. <a href="#gaaa45d7554ef419bab882a268fe10c49b">More...</a><br /></td></tr>
<tr class="separator:gaaa45d7554ef419bab882a268fe10c49b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1da77052138283fc09771fbae65e7859"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga1da77052138283fc09771fbae65e7859">oval_session::oval_session_set_report_export</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, const char *filename)</td></tr>
<tr class="memdesc:ga1da77052138283fc09771fbae65e7859"><td class="mdescLeft"> </td><td class="mdescRight">Set a name of the file that the the OVAL Results, converted to HTML format, will be written into. <a href="#ga1da77052138283fc09771fbae65e7859">More...</a><br /></td></tr>
<tr class="separator:ga1da77052138283fc09771fbae65e7859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb9c0ae48eb85fce3dfa23a295924abf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gadb9c0ae48eb85fce3dfa23a295924abf">oval_session::oval_session_set_xml_reporter</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, xml_reporter fn)</td></tr>
<tr class="memdesc:gadb9c0ae48eb85fce3dfa23a295924abf"><td class="mdescLeft"> </td><td class="mdescRight">Set XML validation reporter. <a href="#gadb9c0ae48eb85fce3dfa23a295924abf">More...</a><br /></td></tr>
<tr class="separator:gadb9c0ae48eb85fce3dfa23a295924abf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga309ceb9135f21b6379e96b13ffa228b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga309ceb9135f21b6379e96b13ffa228b1">oval_session::oval_session_load</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session)</td></tr>
<tr class="memdesc:ga309ceb9135f21b6379e96b13ffa228b1"><td class="mdescLeft"> </td><td class="mdescRight">Load OVAL Definitions and bind OVAL Variables to it if provided. <a href="#ga309ceb9135f21b6379e96b13ffa228b1">More...</a><br /></td></tr>
<tr class="separator:ga309ceb9135f21b6379e96b13ffa228b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb648c99af7305cac35f8f3112c2924a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gabb648c99af7305cac35f8f3112c2924a">oval_session::oval_session_evaluate_id</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, char *probe_root, const char *id, <a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a> *result)</td></tr>
<tr class="memdesc:gabb648c99af7305cac35f8f3112c2924a"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate a specific OVAL Definition. <a href="#gabb648c99af7305cac35f8f3112c2924a">More...</a><br /></td></tr>
<tr class="separator:gabb648c99af7305cac35f8f3112c2924a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada348d40a3cf13cca0ebabd7bb98a974"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#gada348d40a3cf13cca0ebabd7bb98a974">oval_session::oval_session_evaluate</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session, char *probe_root, agent_reporter fn, void *arg)</td></tr>
<tr class="memdesc:gada348d40a3cf13cca0ebabd7bb98a974"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate OVAL Definitions. <a href="#gada348d40a3cf13cca0ebabd7bb98a974">More...</a><br /></td></tr>
<tr class="separator:gada348d40a3cf13cca0ebabd7bb98a974"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64194014bef9a80546a09812efdfd54e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga64194014bef9a80546a09812efdfd54e">oval_session::oval_session_export</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session)</td></tr>
<tr class="memdesc:ga64194014bef9a80546a09812efdfd54e"><td class="mdescLeft"> </td><td class="mdescRight">Export result to a file. <a href="#ga64194014bef9a80546a09812efdfd54e">More...</a><br /></td></tr>
<tr class="separator:ga64194014bef9a80546a09812efdfd54e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga53d2d61436a2ac1ee905cbec503f39ef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSESSION.html#ga53d2d61436a2ac1ee905cbec503f39ef">oval_session::oval_session_free</a> (struct <a class="el" href="structoval__session.html">oval_session</a> *session)</td></tr>
<tr class="memdesc:ga53d2d61436a2ac1ee905cbec503f39ef"><td class="mdescLeft"> </td><td class="mdescRight">Destructor of an <a class="el" href="structoval__session.html">oval_session</a>. <a href="#ga53d2d61436a2ac1ee905cbec503f39ef">More...</a><br /></td></tr>
<tr class="separator:ga53d2d61436a2ac1ee905cbec503f39ef"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>OVAL Session. </p>
<p>This is a high level API for OVAL Definition content evaluation, collection of OVAL System Characteristics and analysing of OVAL Definitions and collected OVAL System Characteristics. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gada348d40a3cf13cca0ebabd7bb98a974"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_session_evaluate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>probe_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">agent_reporter </td>
<td class="paramname"><em>fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate OVAL Definitions. </p>
<p>Optionally you can set a callback function which will be called upon single evaluation. Use oval_result_definition_get_id to get the ID of the evaluated OVAL Definion and oval_result_definition_get_result, oval_result_get_text to get a text representation of the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">probe_root</td><td>FIXME: </td></tr>
<tr><td class="paramname">fn</td><td>a callback function </td></tr>
<tr><td class="paramname">arg</td><td>an optional argument for your callback function</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">1</td><td>on an internal error (use <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> or <a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> to get more details) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabb648c99af7305cac35f8f3112c2924a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_session_evaluate_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>probe_root</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 class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a> * </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate a specific OVAL Definition. </p>
<p>The result of the evaluation will be written into the result argument. You can convert it into a string representation with oval_result_get_text.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">probe_root</td><td>FIXME: </td></tr>
<tr><td class="paramname">id</td><td>id of an OVAL Definition </td></tr>
<tr><td class="paramname">result</td><td>variable to write the result into</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">1</td><td>on an internal error (use <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> or <a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> to get more details) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga64194014bef9a80546a09812efdfd54e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_session_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export result to a file. </p>
<p>Results can be represented as OVAL System Characteristics if analyse has been done or OVAL Results if evaluation or collect has been done. If there aren't any filenames set or no operation was performed then this function has no effect.</p>
<p>Alse see: <a class="el" href="group__OVALSESSION.html#gaaa45d7554ef419bab882a268fe10c49b">oval_session_set_results_export</a> <a class="el" href="group__OVALSESSION.html#ga1da77052138283fc09771fbae65e7859">oval_session_set_report_export</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">1</td><td>on an internal error (use <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> or <a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> to get more details) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga53d2d61436a2ac1ee905cbec503f39ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor of an <a class="el" href="structoval__session.html">oval_session</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga309ceb9135f21b6379e96b13ffa228b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_session_load </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load OVAL Definitions and bind OVAL Variables to it if provided. </p>
<p>Validation if performed automatically if you've set it with <a class="el" href="group__OVALSESSION.html#ga55489ebe12b237bc5a15fdfafb893d88">oval_session_set_validation</a>. if the validation failed then the function will print information about what line in what file isn't valid and why not.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">1</td><td>on an internal error (use <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> or <a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> to get more details) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga13fa3e11919545b7ba86c1e26fdbc7d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoval__session.html">oval_session</a> * oval_session_new </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Costructor of an <a class="el" href="structoval__session.html">oval_session</a>. </p>
<p>It attempts to recognize a type of the filename which has to be a source datastream or OVAL Definitions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>a path to an OVAL or source datastream file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly created <a class="el" href="structoval__session.html">oval_session</a> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>in case of an error (use <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc</a> or <a class="el" href="group__ERRORS.html#ga75a2a4b96d3c6ab06845c6cd0e37b15d">oscap_err_get_full_error</a> to get more details) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabc9e4924bbcbf3b929604c32d77d6931"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_component_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</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>Set ID of a particular OVAL component if there are two OVALs in one source datastream. </p>
<p>If the ID has been already set then it will be overwritten.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">id</td><td>an id of a definition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac0a997f4f7ad2ada20f98394485afd54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_datastream_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</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>Set ID of a specific OVAL Definition in an source datastream. </p>
<p>If the ID has been already set then it will be overwritten. In case where there are two OVALs in one datastream use <a class="el" href="group__OVALSESSION.html#gabc9e4924bbcbf3b929604c32d77d6931">oval_session_set_component_id</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">id</td><td>an id of a definition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga70136bc8978a51ee0ce751d100200b19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_directives </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set OVAL Directives. </p>
<p>If a filename has been already set then it will be overwritten. If you pass NULL as filename argument then the currently set variables will be freed. Validation of the format will be perforemed when the <a class="el" href="group__OVALSESSION.html#ga309ceb9135f21b6379e96b13ffa228b1">oval_session_load</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">filename</td><td>a path to an OVAL Directives file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1da77052138283fc09771fbae65e7859"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_report_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a name of the file that the the OVAL Results, converted to HTML format, will be written into. </p>
<p>If the file's name has been already set for the current session then it will be overwritten.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">filename</td><td>a path to a new file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaaa45d7554ef419bab882a268fe10c49b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_results_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a name of the file that the the OVAL Results will be written into. </p>
<p>If the file's name has been already set for the current session then it will be overwritten.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">filename</td><td>a path to a new file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga55489ebe12b237bc5a15fdfafb893d88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_validation </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>validate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>full_validation</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set XSD validation level. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">validate</td><td>false value indicates to skip any XSD validation </td></tr>
<tr><td class="paramname">full_validation</td><td>true value indicates that every possible step will be validated by XSD </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga27c4c63cf1bbb59f91a7773723074105"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_variables </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set OVAL Variables. </p>
<p>If a filename has been already set then it will be overwritten. If you pass NULL as filename argument then the currently set variables will be freed. Validation of the format will be perforemed when the <a class="el" href="group__OVALSESSION.html#ga309ceb9135f21b6379e96b13ffa228b1">oval_session_load</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">filename</td><td>a path to an OVAL Variables file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadb9c0ae48eb85fce3dfa23a295924abf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_session_set_xml_reporter </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__session.html">oval_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xml_reporter </td>
<td class="paramname"><em>fn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set XML validation reporter. </p>
<p>This function is called when there is something invalid in input/output XML file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>an <a class="el" href="structoval__session.html">oval_session</a> </td></tr>
<tr><td class="paramname">fn</td><td>pointer to XML reporter function </td></tr>
</table>
</dd>
</dl>
</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>