<!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: Session</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#files">Files</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Session</div> </div>
<div class="ingroups"><a class="el" href="group__XCCDF.html">XCCDF</a></div></div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:xccdf__session_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="xccdf__session_8h.html">xccdf_session.h</a></td></tr>
<tr class="memdesc:xccdf__session_8h"><td class="mdescLeft"> </td><td class="mdescRight">High Level API for OpenSCAP XCCDF operations. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><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="structxccdf__session.html">xccdf_session</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A structure encapsulating the context of XCCDF operations. <a href="structxccdf__session.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaeecd8f70044737a40e55d82e92f5f054"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaeecd8f70044737a40e55d82e92f5f054">download_progress_calllback_t</a> )(bool warning, const char *format,...)</td></tr>
<tr class="memdesc:gaeecd8f70044737a40e55d82e92f5f054"><td class="mdescLeft"> </td><td class="mdescRight">Type of the function used to report progress of download. <a href="#gaeecd8f70044737a40e55d82e92f5f054"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf39a40011982983985265859716d8405"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaf39a40011982983985265859716d8405">xccdf_session::xccdf_session_new</a> (const char *filename)</td></tr>
<tr class="memdesc:gaf39a40011982983985265859716d8405"><td class="mdescLeft"> </td><td class="mdescRight">Costructor of <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. <a href="#gaf39a40011982983985265859716d8405"></a><br/></td></tr>
<tr class="memitem:ga8dd11df3e2509a9612395da1dc9e2e11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga8dd11df3e2509a9612395da1dc9e2e11">xccdf_session::xccdf_session_free</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga8dd11df3e2509a9612395da1dc9e2e11"><td class="mdescLeft"> </td><td class="mdescRight">Destructor of <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. <a href="#ga8dd11df3e2509a9612395da1dc9e2e11"></a><br/></td></tr>
<tr class="memitem:gac45d41886131e874d79913bce3a77930"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac45d41886131e874d79913bce3a77930"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gac45d41886131e874d79913bce3a77930">xccdf_session::xccdf_session_get_filename</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gac45d41886131e874d79913bce3a77930"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the filename the session was created with. <br/></td></tr>
<tr class="memitem:ga51eecb91141f7c1078b4e45fcf67d43b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga51eecb91141f7c1078b4e45fcf67d43b">xccdf_session::xccdf_session_is_sds</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga51eecb91141f7c1078b4e45fcf67d43b"><td class="mdescLeft"> </td><td class="mdescRight">Query if the session is based on Source DataStream. <a href="#ga51eecb91141f7c1078b4e45fcf67d43b"></a><br/></td></tr>
<tr class="memitem:gadd46ecf6505760ccf1a3cc6f5464346a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gadd46ecf6505760ccf1a3cc6f5464346a">xccdf_session::xccdf_session_set_validation</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, bool validate, bool full_validation)</td></tr>
<tr class="memdesc:gadd46ecf6505760ccf1a3cc6f5464346a"><td class="mdescLeft"> </td><td class="mdescRight">Set XSD validation level. <a href="#gadd46ecf6505760ccf1a3cc6f5464346a"></a><br/></td></tr>
<tr class="memitem:gaa94861e198ceaf9f10e498ec51579b4e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaa94861e198ceaf9f10e498ec51579b4e">xccdf_session::xccdf_session_set_datastream_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *datastream_id)</td></tr>
<tr class="memdesc:gaa94861e198ceaf9f10e498ec51579b4e"><td class="mdescLeft"> </td><td class="mdescRight">Set requested datastream_id for this session. <a href="#gaa94861e198ceaf9f10e498ec51579b4e"></a><br/></td></tr>
<tr class="memitem:gae07a65fcb07c373ea94c8facebad0d67"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gae07a65fcb07c373ea94c8facebad0d67">xccdf_session::xccdf_session_get_datastream_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gae07a65fcb07c373ea94c8facebad0d67"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the datastream id. <a href="#gae07a65fcb07c373ea94c8facebad0d67"></a><br/></td></tr>
<tr class="memitem:ga3f20ab1f4505d2088adcbfb74d613c33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga3f20ab1f4505d2088adcbfb74d613c33">xccdf_session::xccdf_session_set_component_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *component_id)</td></tr>
<tr class="memdesc:ga3f20ab1f4505d2088adcbfb74d613c33"><td class="mdescLeft"> </td><td class="mdescRight">Set requested component_id for this session. <a href="#ga3f20ab1f4505d2088adcbfb74d613c33"></a><br/></td></tr>
<tr class="memitem:gaf2e3dacee19d4cdd4ea6507557fb9c39"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaf2e3dacee19d4cdd4ea6507557fb9c39">xccdf_session::xccdf_session_get_component_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gaf2e3dacee19d4cdd4ea6507557fb9c39"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the component id. <a href="#gaf2e3dacee19d4cdd4ea6507557fb9c39"></a><br/></td></tr>
<tr class="memitem:ga331adf72f059417b32f725c287cd1683"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga331adf72f059417b32f725c287cd1683">xccdf_session::xccdf_session_set_user_cpe</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *user_cpe)</td></tr>
<tr class="memdesc:ga331adf72f059417b32f725c287cd1683"><td class="mdescLeft"> </td><td class="mdescRight">Set path to custom CPE dictionary for the session. <a href="#ga331adf72f059417b32f725c287cd1683"></a><br/></td></tr>
<tr class="memitem:gabb8b83bbe3d0e7121133b4b38a46d283"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gabb8b83bbe3d0e7121133b4b38a46d283">xccdf_session::xccdf_session_set_user_tailoring_file</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *user_tailoring_file)</td></tr>
<tr class="memdesc:gabb8b83bbe3d0e7121133b4b38a46d283"><td class="mdescLeft"> </td><td class="mdescRight">Set path to custom Tailoring file for the session. <a href="#gabb8b83bbe3d0e7121133b4b38a46d283"></a><br/></td></tr>
<tr class="memitem:gae227d6e5636cae87542a072fc076232f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gae227d6e5636cae87542a072fc076232f">xccdf_session::xccdf_session_set_user_tailoring_cid</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *user_tailoring_cid)</td></tr>
<tr class="memdesc:gae227d6e5636cae87542a072fc076232f"><td class="mdescLeft"> </td><td class="mdescRight">Set ID of Tailoring component for the session. <a href="#gae227d6e5636cae87542a072fc076232f"></a><br/></td></tr>
<tr class="memitem:gab2d180318504c3906f22de9f4bd223aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gab2d180318504c3906f22de9f4bd223aa">xccdf_session::xccdf_session_set_remote_resources</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, bool allowed, <a class="el" href="group__Session.html#gaeecd8f70044737a40e55d82e92f5f054">download_progress_calllback_t</a> <a class="el" href="structcallback__t.html">callback</a>)</td></tr>
<tr class="memdesc:gab2d180318504c3906f22de9f4bd223aa"><td class="mdescLeft"> </td><td class="mdescRight">Set properties of remote content. <a href="#gab2d180318504c3906f22de9f4bd223aa"></a><br/></td></tr>
<tr class="memitem:ga6b819845ec43c5cc15e29a610e2ef3c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga6b819845ec43c5cc15e29a610e2ef3c6">xccdf_session::xccdf_session_set_custom_oval_files</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, char **oval_filenames)</td></tr>
<tr class="memdesc:ga6b819845ec43c5cc15e29a610e2ef3c6"><td class="mdescLeft"> </td><td class="mdescRight">Set custom oval files for this session. <a href="#ga6b819845ec43c5cc15e29a610e2ef3c6"></a><br/></td></tr>
<tr class="memitem:ga833de8cec0905e3d3a7b6e1ca9c36c26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga833de8cec0905e3d3a7b6e1ca9c36c26">xccdf_session::xccdf_session_set_custom_oval_eval_fn</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, <a class="el" href="group__XCCDF__POLICY.html#ga322816631128d9e1e513441b0d87a9c4">xccdf_policy_engine_eval_fn</a> eval_fn)</td></tr>
<tr class="memdesc:ga833de8cec0905e3d3a7b6e1ca9c36c26"><td class="mdescLeft"> </td><td class="mdescRight">Set custom OVAL eval function to register with each OVAL session. <a href="#ga833de8cec0905e3d3a7b6e1ca9c36c26"></a><br/></td></tr>
<tr class="memitem:ga4a467a1726398c9600add9acea15f6fb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga4a467a1726398c9600add9acea15f6fb">xccdf_session::xccdf_session_set_product_cpe</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *product_cpe)</td></tr>
<tr class="memdesc:ga4a467a1726398c9600add9acea15f6fb"><td class="mdescLeft"> </td><td class="mdescRight">Set custom product CPE name. <a href="#ga4a467a1726398c9600add9acea15f6fb"></a><br/></td></tr>
<tr class="memitem:gacba4427ca2afa15e6bacee29930c6f8f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gacba4427ca2afa15e6bacee29930c6f8f">xccdf_session::xccdf_session_set_oval_results_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, bool to_export_oval_results)</td></tr>
<tr class="memdesc:gacba4427ca2afa15e6bacee29930c6f8f"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the OVAL result files shall be exported. <a href="#gacba4427ca2afa15e6bacee29930c6f8f"></a><br/></td></tr>
<tr class="memitem:ga6d9140841bcf97a61b5b5fbaed635d4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga6d9140841bcf97a61b5b5fbaed635d4c">xccdf_session::xccdf_session_set_sce_results_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, bool to_export_sce_results)</td></tr>
<tr class="memdesc:ga6d9140841bcf97a61b5b5fbaed635d4c"><td class="mdescLeft"> </td><td class="mdescRight">Set that SCE reult files shall be exported. <a href="#ga6d9140841bcf97a61b5b5fbaed635d4c"></a><br/></td></tr>
<tr class="memitem:ga7c9cd998234e40f960cb572d5e93dd9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga7c9cd998234e40f960cb572d5e93dd9c">xccdf_session::xccdf_session_set_oval_variables_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, bool to_export_oval_variables)</td></tr>
<tr class="memdesc:ga7c9cd998234e40f960cb572d5e93dd9c"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the OVAL variables files shall be exported. <a href="#ga7c9cd998234e40f960cb572d5e93dd9c"></a><br/></td></tr>
<tr class="memitem:ga005e2f357567c3f86014a4764e72388b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga005e2f357567c3f86014a4764e72388b">xccdf_session::xccdf_session_set_xccdf_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *xccdf_file)</td></tr>
<tr class="memdesc:ga005e2f357567c3f86014a4764e72388b"><td class="mdescLeft"> </td><td class="mdescRight">Set where to export XCCDF file. <a href="#ga005e2f357567c3f86014a4764e72388b"></a><br/></td></tr>
<tr class="memitem:ga9b9ae30eaa820fed7e508861d954b5da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga9b9ae30eaa820fed7e508861d954b5da">xccdf_session::xccdf_session_set_arf_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *arf_file)</td></tr>
<tr class="memdesc:ga9b9ae30eaa820fed7e508861d954b5da"><td class="mdescLeft"> </td><td class="mdescRight">Set where to export ARF file. <a href="#ga9b9ae30eaa820fed7e508861d954b5da"></a><br/></td></tr>
<tr class="memitem:gaeee932012b3a9999aa6a6128a5155d6f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaeee932012b3a9999aa6a6128a5155d6f">xccdf_session::xccdf_session_set_report_export</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *report_file)</td></tr>
<tr class="memdesc:gaeee932012b3a9999aa6a6128a5155d6f"><td class="mdescLeft"> </td><td class="mdescRight">Set where to export HTML Report file. <a href="#gaeee932012b3a9999aa6a6128a5155d6f"></a><br/></td></tr>
<tr class="memitem:gafacd3b860d5f48d7987110ece5c6f7bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gafacd3b860d5f48d7987110ece5c6f7bc">xccdf_session::xccdf_session_set_profile_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *profile_id)</td></tr>
<tr class="memdesc:gafacd3b860d5f48d7987110ece5c6f7bc"><td class="mdescLeft"> </td><td class="mdescRight">Select XCCDF Profile for evaluation. <a href="#gafacd3b860d5f48d7987110ece5c6f7bc"></a><br/></td></tr>
<tr class="memitem:ga7848b63ac964bea704a50b7eba232b8e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga7848b63ac964bea704a50b7eba232b8e">xccdf_session::xccdf_session_get_profile_id</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga7848b63ac964bea704a50b7eba232b8e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves ID of the profile that we will evaluate with, or NULL. <a href="#ga7848b63ac964bea704a50b7eba232b8e"></a><br/></td></tr>
<tr class="memitem:gaa7281be8f1669d5fbedb0a7305b9797a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaa7281be8f1669d5fbedb0a7305b9797a">xccdf_session::xccdf_session_get_sds_idx</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gaa7281be8f1669d5fbedb0a7305b9797a"><td class="mdescLeft"> </td><td class="mdescRight">Get Source DataStream index of the session. <a href="#gaa7281be8f1669d5fbedb0a7305b9797a"></a><br/></td></tr>
<tr class="memitem:ga430e93ea61903a2c127da7e05a0c314b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga430e93ea61903a2c127da7e05a0c314b">xccdf_session::xccdf_session_load</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga430e93ea61903a2c127da7e05a0c314b"><td class="mdescLeft"> </td><td class="mdescRight">Load and parse all XCCDF structures needed to evaluate this session. <a href="#ga430e93ea61903a2c127da7e05a0c314b"></a><br/></td></tr>
<tr class="memitem:ga6b479bd2a8672ae215d3dc1d3585e3c1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga6b479bd2a8672ae215d3dc1d3585e3c1">xccdf_session::xccdf_session_load_xccdf</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga6b479bd2a8672ae215d3dc1d3585e3c1"><td class="mdescLeft"> </td><td class="mdescRight">Load and parse XCCDF file. <a href="#ga6b479bd2a8672ae215d3dc1d3585e3c1"></a><br/></td></tr>
<tr class="memitem:ga6f73bde145e16b64cbf1bf2b92885703"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga6f73bde145e16b64cbf1bf2b92885703">xccdf_session::xccdf_session_load_cpe</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga6f73bde145e16b64cbf1bf2b92885703"><td class="mdescLeft"> </td><td class="mdescRight">Load and parse CPE dictionaries. <a href="#ga6f73bde145e16b64cbf1bf2b92885703"></a><br/></td></tr>
<tr class="memitem:ga283bcbfaa76410198f331e774509ff38"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga283bcbfaa76410198f331e774509ff38">xccdf_session::xccdf_session_load_oval</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga283bcbfaa76410198f331e774509ff38"><td class="mdescLeft"> </td><td class="mdescRight">Load and parse OVAL definitions files for the XCCDF session. <a href="#ga283bcbfaa76410198f331e774509ff38"></a><br/></td></tr>
<tr class="memitem:ga8fffc0c6fc1ca98fcd0595ddb61e5e99"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga8fffc0c6fc1ca98fcd0595ddb61e5e99">xccdf_session::xccdf_session_load_sce</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga8fffc0c6fc1ca98fcd0595ddb61e5e99"><td class="mdescLeft"> </td><td class="mdescRight">Load Script Check Engine (if available) to the XCCDF session. <a href="#ga8fffc0c6fc1ca98fcd0595ddb61e5e99"></a><br/></td></tr>
<tr class="memitem:ga405b03a6d66db4edc6a79d19467c33d3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga405b03a6d66db4edc6a79d19467c33d3">xccdf_session::xccdf_session_load_tailoring</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga405b03a6d66db4edc6a79d19467c33d3"><td class="mdescLeft"> </td><td class="mdescRight">Load Tailoring file (if applicable) to the XCCDF session. <a href="#ga405b03a6d66db4edc6a79d19467c33d3"></a><br/></td></tr>
<tr class="memitem:ga30af924563049e65ab195c5c1db19887"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga30af924563049e65ab195c5c1db19887">xccdf_session::xccdf_session_evaluate</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga30af924563049e65ab195c5c1db19887"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate XCCDF Policy. <a href="#ga30af924563049e65ab195c5c1db19887"></a><br/></td></tr>
<tr class="memitem:gaec2a874ec114ab18bc8bebf575897920"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaec2a874ec114ab18bc8bebf575897920">xccdf_session::xccdf_session_export_xccdf</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gaec2a874ec114ab18bc8bebf575897920"><td class="mdescLeft"> </td><td class="mdescRight">Export XCCDF file. <a href="#gaec2a874ec114ab18bc8bebf575897920"></a><br/></td></tr>
<tr class="memitem:ga6a3f0bdb3001e2865d8a4483487702b2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga6a3f0bdb3001e2865d8a4483487702b2">xccdf_session::xccdf_session_export_oval</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga6a3f0bdb3001e2865d8a4483487702b2"><td class="mdescLeft"> </td><td class="mdescRight">Export OVAL (result and variables) files. <a href="#ga6a3f0bdb3001e2865d8a4483487702b2"></a><br/></td></tr>
<tr class="memitem:ga748488209fd373a65d26cd2fd21277b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga748488209fd373a65d26cd2fd21277b9">xccdf_session::xccdf_session_export_sce</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga748488209fd373a65d26cd2fd21277b9"><td class="mdescLeft"> </td><td class="mdescRight">Export SCE files (if enabled by <a class="el" href="group__Session.html#ga6d9140841bcf97a61b5b5fbaed635d4c">xccdf_session_set_sce_results_export</a>). <a href="#ga748488209fd373a65d26cd2fd21277b9"></a><br/></td></tr>
<tr class="memitem:gafb4dbad9fd2073f84367787305f640c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gafb4dbad9fd2073f84367787305f640c0">xccdf_session::xccdf_session_export_arf</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:gafb4dbad9fd2073f84367787305f640c0"><td class="mdescLeft"> </td><td class="mdescRight">Export ARF (if enabled by <a class="el" href="group__Session.html#ga9b9ae30eaa820fed7e508861d954b5da">xccdf_session_set_arf_export</a>). <a href="#gafb4dbad9fd2073f84367787305f640c0"></a><br/></td></tr>
<tr class="memitem:ga19d4574d9854fb9d0fb08363c4535382"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxccdf__policy__model.html">xccdf_policy_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga19d4574d9854fb9d0fb08363c4535382">xccdf_session::xccdf_session_get_policy_model</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga19d4574d9854fb9d0fb08363c4535382"><td class="mdescLeft"> </td><td class="mdescRight">Get policy_model of the session. <a href="#ga19d4574d9854fb9d0fb08363c4535382"></a><br/></td></tr>
<tr class="memitem:ga5fea127038f1c5a3f8f2bb6c96660700"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga5fea127038f1c5a3f8f2bb6c96660700">xccdf_session::xccdf_session_get_xccdf_policy</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga5fea127038f1c5a3f8f2bb6c96660700"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="structxccdf__policy.html" title="XCCDF policy structure is abstract (class) structure of Profile element from benchmark.">xccdf_policy</a> of the session. <a href="#ga5fea127038f1c5a3f8f2bb6c96660700"></a><br/></td></tr>
<tr class="memitem:ga651159529503dcd007ba16907a636c1a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga651159529503dcd007ba16907a636c1a">xccdf_session::xccdf_session_get_base_score</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga651159529503dcd007ba16907a636c1a"><td class="mdescLeft"> </td><td class="mdescRight">Get the base score of the latest XCCDF evaluation in the session. <a href="#ga651159529503dcd007ba16907a636c1a"></a><br/></td></tr>
<tr class="memitem:ga53cd81a6cb77b2b6e40bdbe5ef68d55d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga53cd81a6cb77b2b6e40bdbe5ef68d55d">xccdf_session::xccdf_session_get_oval_agents_count</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga53cd81a6cb77b2b6e40bdbe5ef68d55d"><td class="mdescLeft"> </td><td class="mdescRight">Get count of OVAL agent sessions in the <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. <a href="#ga53cd81a6cb77b2b6e40bdbe5ef68d55d"></a><br/></td></tr>
<tr class="memitem:ga5525deae061a0cff6af315aadc7dc7ff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga5525deae061a0cff6af315aadc7dc7ff">xccdf_session::xccdf_session_contains_fail_result</a> (const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga5525deae061a0cff6af315aadc7dc7ff"><td class="mdescLeft"> </td><td class="mdescRight">Query if the result of evaluation contains FAIL, ERROR, or UNKNOWN rule-result elements. <a href="#ga5525deae061a0cff6af315aadc7dc7ff"></a><br/></td></tr>
<tr class="memitem:ga4116b2c3aa35308bec798f6c409af85c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#ga4116b2c3aa35308bec798f6c409af85c">xccdf_session::xccdf_session_remediate</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session)</td></tr>
<tr class="memdesc:ga4116b2c3aa35308bec798f6c409af85c"><td class="mdescLeft"> </td><td class="mdescRight">Run XCCDF Remediation. <a href="#ga4116b2c3aa35308bec798f6c409af85c"></a><br/></td></tr>
<tr class="memitem:gaa0f5afca12b8262826277cf2ff45c7dc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Session.html#gaa0f5afca12b8262826277cf2ff45c7dc">xccdf_session::xccdf_session_build_policy_from_testresult</a> (struct <a class="el" href="structxccdf__session.html">xccdf_session</a> *session, const char *testresult_id)</td></tr>
<tr class="memdesc:gaa0f5afca12b8262826277cf2ff45c7dc"><td class="mdescLeft"> </td><td class="mdescRight">Load xccdf:TestResult to the session from file and prepare session for remediation. <a href="#gaa0f5afca12b8262826277cf2ff45c7dc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaeecd8f70044737a40e55d82e92f5f054"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* download_progress_calllback_t)(bool warning, const char *format,...)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of the function used to report progress of download. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">warning</td><td>indicates whether the message is rather warning or notice </td></tr>
<tr><td class="paramname">format</td><td>printf-like format string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa0f5afca12b8262826277cf2ff45c7dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_build_policy_from_testresult </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>testresult_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load xccdf:TestResult to the session from file and prepare session for remediation. </p>
<p>This function assumes that the session internals has the policy_model prepared, it calculates all the other internals which might be needed for remediation.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">testresult_id</td><td>ID of the TestResult element in the file (the NULL value stands for the last TestResult). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5525deae061a0cff6af315aadc7dc7ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_contains_fail_result </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query if the result of evaluation contains FAIL, ERROR, or UNKNOWN rule-result elements. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Exists such rule-result r . r = FAIL | r = UNKNOWN | r = ERROR </dd></dl>
</div>
</div>
<a class="anchor" id="ga30af924563049e65ab195c5c1db19887"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_evaluate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate XCCDF Policy. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="gafb4dbad9fd2073f84367787305f640c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_export_arf </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export ARF (if enabled by <a class="el" href="group__Session.html#ga9b9ae30eaa820fed7e508861d954b5da">xccdf_session_set_arf_export</a>). </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga6a3f0bdb3001e2865d8a4483487702b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_export_oval </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export OVAL (result and variables) files. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga748488209fd373a65d26cd2fd21277b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_export_sce </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export SCE files (if enabled by <a class="el" href="group__Session.html#ga6d9140841bcf97a61b5b5fbaed635d4c">xccdf_session_set_sce_results_export</a>). </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="gaec2a874ec114ab18bc8bebf575897920"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_export_xccdf </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export XCCDF file. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga8dd11df3e2509a9612395da1dc9e2e11"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor of <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga651159529503dcd007ba16907a636c1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float xccdf_session_get_base_score </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the base score of the latest XCCDF evaluation in the session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>the score </dd></dl>
</div>
</div>
<a class="anchor" id="gaf2e3dacee19d4cdd4ea6507557fb9c39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xccdf_session_get_component_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the component id. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__Session.html#ga3f20ab1f4505d2088adcbfb74d613c33" title="Set requested component_id for this session.">xccdf_session_set_component_id</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae07a65fcb07c373ea94c8facebad0d67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xccdf_session_get_datastream_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the datastream id. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__Session.html#gaa94861e198ceaf9f10e498ec51579b4e" title="Set requested datastream_id for this session.">xccdf_session_set_datastream_id</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga53cd81a6cb77b2b6e40bdbe5ef68d55d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int xccdf_session_get_oval_agents_count </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get count of OVAL agent sessions in the <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>number of OVAL agents. </dd></dl>
</div>
</div>
<a class="anchor" id="ga19d4574d9854fb9d0fb08363c4535382"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxccdf__policy__model.html">xccdf_policy_model</a> * xccdf_session_get_policy_model </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get policy_model of the session. </p>
<p>The <a class="el" href="group__Session.html#ga6b479bd2a8672ae215d3dc1d3585e3c1">xccdf_session_load_xccdf</a> shall be run before this to parse XCCDF file to the policy_model.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>XCCDF Policy Model or NULL in case of failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7848b63ac964bea704a50b7eba232b8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xccdf_session_get_profile_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves ID of the profile that we will evaluate with, or NULL. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa7281be8f1669d5fbedb0a7305b9797a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * xccdf_session_get_sds_idx </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Source DataStream index of the session. </p>
<dl class="section warning"><dt>Warning:</dt><dd>This is applicable only on sessions which are SDS. NULL is returned otherwise. </dd></dl>
<dl class="section return"><dt>Returns:</dt><dd>sds index</dd></dl>
<dl class="section warning"><dt>Warning:</dt><dd>This is applicable only on sessions which are SDS. </dd></dl>
<dl class="section return"><dt>Returns:</dt><dd>sds index </dd></dl>
</div>
</div>
<a class="anchor" id="ga5fea127038f1c5a3f8f2bb6c96660700"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> * xccdf_session_get_xccdf_policy </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="structxccdf__policy.html" title="XCCDF policy structure is abstract (class) structure of Profile element from benchmark.">xccdf_policy</a> of the session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>XCCDF Policy or NULL in case of failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga51eecb91141f7c1078b4e45fcf67d43b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_is_sds </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query if the session is based on Source DataStream. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true if the session is based on Source Datastream </dd></dl>
</div>
</div>
<a class="anchor" id="ga430e93ea61903a2c127da7e05a0c314b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and parse all XCCDF structures needed to evaluate this session. </p>
<p>This is only a placeholder for load_xccdf, load_cpe, load_oval and load_sce functions.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga6f73bde145e16b64cbf1bf2b92885703"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load_cpe </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and parse CPE dictionaries. </p>
<p>Function xccdf_session_set_user_cpe might be called before this to set custom CPE dictionary.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga283bcbfaa76410198f331e774509ff38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load_oval </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and parse OVAL definitions files for the XCCDF session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga8fffc0c6fc1ca98fcd0595ddb61e5e99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load_sce </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load Script Check Engine (if available) to the XCCDF session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga405b03a6d66db4edc6a79d19467c33d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load_tailoring </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load Tailoring file (if applicable) to the XCCDF session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga6b479bd2a8672ae215d3dc1d3585e3c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_load_xccdf </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and parse XCCDF file. </p>
<p>If the file upon which is based this session is Source DataStream use functions <a class="el" href="group__Session.html#gaa94861e198ceaf9f10e498ec51579b4e">xccdf_session_set_datastream_id</a> and <a class="el" href="group__Session.html#ga3f20ab1f4505d2088adcbfb74d613c33">xccdf_session_set_component_id</a> to select particular component within that DataStream to parse. This function is reentrant meaning that it allows user to change i.e. component_id and load_xccdf again in the very same session. However in such case, previous xccdf structures will be deallocated from session and pointers to it become invalid.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="gaf39a40011982983985265859716d8405"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * xccdf_session_new </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Costructor of <a class="el" href="structxccdf__session.html" title="A structure encapsulating the context of XCCDF operations.">xccdf_session</a>. </p>
<p>It attempts to recognize type of the filename.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>path to XCCDF or DS file. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>newly created <a class="el" href="structxccdf__session.html">xccdf_session</a>. </dd></dl>
<dl class="retval"><dt>Return values:</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>is returned in case of error. Details might be found through <a class="el" href="group__ERRORS.html#ga40156d16cfcddd2596f56b9fcc5f752f">oscap_err_desc()</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4116b2c3aa35308bec798f6c409af85c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xccdf_session_remediate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run XCCDF Remediation. </p>
<p>It uses XCCDF Policy and XCCDF TestResult from the session and modifies the TestResult. This also drops and recreate OVAL Agent Session, thus users are advised to run <a class="el" href="group__Session.html#ga6a3f0bdb3001e2865d8a4483487702b2">xccdf_session_export_oval</a> first.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>zero on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga9b9ae30eaa820fed7e508861d954b5da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_set_arf_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>arf_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set where to export ARF file. </p>
<p>NULL value means to not export at all.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">arf_file</td><td>path to ARF file </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga3f20ab1f4505d2088adcbfb74d613c33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_component_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>component_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set requested component_id for this session. </p>
<p>This component_id is later pased down to <a class="el" href="group__DS.html#ga9ae8ef1864feec0a5fbba8b8d8be3dd1">ds_sds_index_select_checklist</a> to determine target component. This function is applicable only for sessions based on a DataStream.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">component_id</td><td>requested component_id for this session. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga833de8cec0905e3d3a7b6e1ca9c36c26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_custom_oval_eval_fn </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_session</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__XCCDF__POLICY.html#ga322816631128d9e1e513441b0d87a9c4">xccdf_policy_engine_eval_fn</a> </td>
<td class="paramname"><em>eval_fn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set custom OVAL eval function to register with each OVAL session. </p>
<p>This function shall be called before OVAL files are parsed.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session. </td></tr>
<tr><td class="paramname">eval_fn</td><td>Callback - pointer to function called by XCCDF Policy for each evaluated rule. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6b819845ec43c5cc15e29a610e2ef3c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_custom_oval_files </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>oval_filenames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set custom oval files for this session. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">oval_filenames</td><td>- Array of paths to custom OVAL files. If the array is empty no OVAL file will be used for the session. If this parameter is NULL then OVAL files will be find automatically, as defined in XCCDF (which is default). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa94861e198ceaf9f10e498ec51579b4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_datastream_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>datastream_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set requested datastream_id for this session. </p>
<p>This datastream_id is later passed down to <a class="el" href="group__DS.html#ga9ae8ef1864feec0a5fbba8b8d8be3dd1">ds_sds_index_select_checklist</a> to determine target component. This function is applicable only for sessions based on a DataStream.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">datastream_id</td><td>requested datastream_id for this session. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gacba4427ca2afa15e6bacee29930c6f8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_oval_results_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>to_export_oval_results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether the OVAL result files shall be exported. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">to_export_oval_results</td><td>whether to export results or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7c9cd998234e40f960cb572d5e93dd9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_oval_variables_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>to_export_oval_variables</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether the OVAL variables files shall be exported. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">to_export_oval_variables</td><td>whether to export results or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4a467a1726398c9600add9acea15f6fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_set_product_cpe </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>product_cpe</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set custom product CPE name. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session. </td></tr>
<tr><td class="paramname">product_cpe</td><td>Name of the scanner product. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="gafacd3b860d5f48d7987110ece5c6f7bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_set_profile_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>profile_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Select XCCDF Profile for evaluation. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">profile_id</td><td>ID of profile to set </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="gab2d180318504c3906f22de9f4bd223aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_remote_resources </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>allowed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Session.html#gaeecd8f70044737a40e55d82e92f5f054">download_progress_calllback_t</a> </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set properties of remote content. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">allowed</td><td>Whether is download od remote resources allowed in this session (defaults to false) </td></tr>
<tr><td class="paramname">callback</td><td>used to notify user about download proceeds. This might be safely set to NULL – ignoring user notification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaeee932012b3a9999aa6a6128a5155d6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_set_report_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>report_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set where to export HTML Report file. </p>
<p>NULL value means to not export at all.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">report_file</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga6d9140841bcf97a61b5b5fbaed635d4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_sce_results_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>to_export_sce_results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set that SCE reult files shall be exported. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">to_export_sce_results</td><td>whether to export SCE results or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga331adf72f059417b32f725c287cd1683"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_user_cpe </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>user_cpe</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set path to custom CPE dictionary for the session. </p>
<p>This function is applicable only before session loads. It has no effect if run afterwards.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">user_cpe</td><td>File path to user defined cpe dictionary. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae227d6e5636cae87542a072fc076232f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_user_tailoring_cid </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>user_tailoring_cid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set ID of Tailoring component for the session. </p>
<p>This function is applicable only before session loads. It has no effect if run afterwards.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">user_tailoring_cid</td><td>ID of component with a tailoring file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabb8b83bbe3d0e7121133b4b38a46d283"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_user_tailoring_file </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>user_tailoring_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set path to custom Tailoring file for the session. </p>
<p>This function is applicable only before session loads. It has no effect if run afterwards.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">user_tailoring_file</td><td>File path to user defined tailoring file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadd46ecf6505760ccf1a3cc6f5464346a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xccdf_session_set_validation </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>XCCDF Session </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="ga005e2f357567c3f86014a4764e72388b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xccdf_session_set_xccdf_export </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__session.html">xccdf_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>xccdf_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set where to export XCCDF file. </p>
<p>NULL value means to not export at all.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>XCCDF Session </td></tr>
<tr><td class="paramname">xccdf_file</td><td>path to XCCDF file </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true on success </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.1.1
</small></address>
</body>
</html>
