| Current File : //usr/share/docs/openscap/html/structds__sds__session.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: ds_sds_session Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ds_sds_session Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a020c2556fea93234fc8c57497532691e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a020c2556fea93234fc8c57497532691e">ds_sds_session_new_from_source</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *<a class="el" href="structds__sds__session.html#a578b998beb941ebd4078234499994866">source</a>)</td></tr>
<tr class="memdesc:a020c2556fea93234fc8c57497532691e"><td class="mdescLeft"> </td><td class="mdescRight">Create new <a class="el" href="structds__sds__session.html">ds_sds_session</a> from existing <a class="el" href="structoscap__source.html">oscap_source</a>. <a href="#a020c2556fea93234fc8c57497532691e">More...</a><br /></td></tr>
<tr class="separator:a020c2556fea93234fc8c57497532691e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f193f4e340ddffeed214b40599dc29b"><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="structds__sds__session.html#a3f193f4e340ddffeed214b40599dc29b">ds_sds_session_get_sds_idx</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session)</td></tr>
<tr class="memdesc:a3f193f4e340ddffeed214b40599dc29b"><td class="mdescLeft"> </td><td class="mdescRight">Get Source DataStream index. <a href="#a3f193f4e340ddffeed214b40599dc29b">More...</a><br /></td></tr>
<tr class="separator:a3f193f4e340ddffeed214b40599dc29b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fd5b896505bf2a770868fcd1fd0096d"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a4fd5b896505bf2a770868fcd1fd0096d">ds_sds_session_select_checklist</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *<a class="el" href="structds__sds__session.html#a9289ec8d754e9bf8584fc3aa561f669e">datastream_id</a>, const char *component_id, const char *benchmark_id)</td></tr>
<tr class="memdesc:a4fd5b896505bf2a770868fcd1fd0096d"><td class="mdescLeft"> </td><td class="mdescRight">Select Checklist (XCCDF presumably) from DataStream collection. <a href="#a4fd5b896505bf2a770868fcd1fd0096d">More...</a><br /></td></tr>
<tr class="separator:a4fd5b896505bf2a770868fcd1fd0096d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7880cbd613a5fb9fd4db032b0ba580a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#ab7880cbd613a5fb9fd4db032b0ba580a">ds_sds_session_select_tailoring</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *component_id)</td></tr>
<tr class="memdesc:ab7880cbd613a5fb9fd4db032b0ba580a"><td class="mdescLeft"> </td><td class="mdescRight">Select XCCDF Tailoring from DataStream collection. <a href="#ab7880cbd613a5fb9fd4db032b0ba580a">More...</a><br /></td></tr>
<tr class="separator:ab7880cbd613a5fb9fd4db032b0ba580a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab836184837ed2ffe1bcdb1f48a37615"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#aab836184837ed2ffe1bcdb1f48a37615">ds_sds_session_set_datastream_id</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *<a class="el" href="structds__sds__session.html#a9289ec8d754e9bf8584fc3aa561f669e">datastream_id</a>)</td></tr>
<tr class="memdesc:aab836184837ed2ffe1bcdb1f48a37615"><td class="mdescLeft"> </td><td class="mdescRight">Set the ID of DataStream within collection to use. <a href="#aab836184837ed2ffe1bcdb1f48a37615">More...</a><br /></td></tr>
<tr class="separator:aab836184837ed2ffe1bcdb1f48a37615"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25746017a38d1526a08b8bf80619415a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a25746017a38d1526a08b8bf80619415a">ds_sds_session_get_datastream_id</a> (const struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session)</td></tr>
<tr class="memdesc:a25746017a38d1526a08b8bf80619415a"><td class="mdescLeft"> </td><td class="mdescRight">Return ID of currently selected DataStream within the DataStream collection. <a href="#a25746017a38d1526a08b8bf80619415a">More...</a><br /></td></tr>
<tr class="separator:a25746017a38d1526a08b8bf80619415a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b70f8b103148d0647bec2b740d50b62"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a7b70f8b103148d0647bec2b740d50b62">ds_sds_session_get_checklist_id</a> (const struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session)</td></tr>
<tr class="memdesc:a7b70f8b103148d0647bec2b740d50b62"><td class="mdescLeft"> </td><td class="mdescRight">Return ID of currently selected component representing XCCDF within the DataStream. <a href="#a7b70f8b103148d0647bec2b740d50b62">More...</a><br /></td></tr>
<tr class="separator:a7b70f8b103148d0647bec2b740d50b62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accb7b9c98985e22bc2252a58c4094d02"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#accb7b9c98985e22bc2252a58c4094d02">ds_sds_session_get_component_by_href</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *href)</td></tr>
<tr class="memdesc:accb7b9c98985e22bc2252a58c4094d02"><td class="mdescLeft"> </td><td class="mdescRight">Get component from Source DataStream by its href. <a href="#accb7b9c98985e22bc2252a58c4094d02">More...</a><br /></td></tr>
<tr class="separator:accb7b9c98985e22bc2252a58c4094d02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ac7c69740576cc687e9a0e975306b80"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a9ac7c69740576cc687e9a0e975306b80">ds_sds_session_register_component_with_dependencies</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *container_name, const char *component_id, const char *target_filename)</td></tr>
<tr class="memdesc:a9ac7c69740576cc687e9a0e975306b80"><td class="mdescLeft"> </td><td class="mdescRight">Register component and its dependencies to internal cache. <a href="#a9ac7c69740576cc687e9a0e975306b80">More...</a><br /></td></tr>
<tr class="separator:a9ac7c69740576cc687e9a0e975306b80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c409fcca09edfd11ad9872c33053cf4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a0c409fcca09edfd11ad9872c33053cf4">ds_sds_session_dump_component_files</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session)</td></tr>
<tr class="memdesc:a0c409fcca09edfd11ad9872c33053cf4"><td class="mdescLeft"> </td><td class="mdescRight">Store cached component files to the disc. <a href="#a0c409fcca09edfd11ad9872c33053cf4">More...</a><br /></td></tr>
<tr class="separator:a0c409fcca09edfd11ad9872c33053cf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78cdf7f25a71ed91728f796b4d7fdaeb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a78cdf7f25a71ed91728f796b4d7fdaeb">ds_sds_session_set_target_dir</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *<a class="el" href="structds__sds__session.html#a720b62ae5a7af962000e724cff231bab">target_dir</a>)</td></tr>
<tr class="memdesc:a78cdf7f25a71ed91728f796b4d7fdaeb"><td class="mdescLeft"> </td><td class="mdescRight">Set target directory for the component files. <a href="#a78cdf7f25a71ed91728f796b4d7fdaeb">More...</a><br /></td></tr>
<tr class="separator:a78cdf7f25a71ed91728f796b4d7fdaeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c7bd0e96cfa68a85886e727ee3f84b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a8c7bd0e96cfa68a85886e727ee3f84b2">ds_sds_session_reset</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session)</td></tr>
<tr class="memdesc:a8c7bd0e96cfa68a85886e727ee3f84b2"><td class="mdescLeft"> </td><td class="mdescRight">Reset session for further use. <a href="#a8c7bd0e96cfa68a85886e727ee3f84b2">More...</a><br /></td></tr>
<tr class="separator:a8c7bd0e96cfa68a85886e727ee3f84b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67ea437b89d70ac698dae9d9184eeb0f"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a67ea437b89d70ac698dae9d9184eeb0f">ds_sds_session_get_html_guide</a> (struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> *session, const char *profile_id)</td></tr>
<tr class="memdesc:a67ea437b89d70ac698dae9d9184eeb0f"><td class="mdescLeft"> </td><td class="mdescRight">Returns HTML representation of selected checklist in form of OpenSCAP guide. <a href="#a67ea437b89d70ac698dae9d9184eeb0f">More...</a><br /></td></tr>
<tr class="separator:a67ea437b89d70ac698dae9d9184eeb0f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a578b998beb941ebd4078234499994866"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a578b998beb941ebd4078234499994866"></a>
struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a578b998beb941ebd4078234499994866">source</a></td></tr>
<tr class="memdesc:a578b998beb941ebd4078234499994866"><td class="mdescLeft"> </td><td class="mdescRight">Source DataStream raw representation. <br /></td></tr>
<tr class="separator:a578b998beb941ebd4078234499994866"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a550bbb6e6a7419f440030f4b015fe875"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550bbb6e6a7419f440030f4b015fe875"></a>
struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a550bbb6e6a7419f440030f4b015fe875">index</a></td></tr>
<tr class="memdesc:a550bbb6e6a7419f440030f4b015fe875"><td class="mdescLeft"> </td><td class="mdescRight">Source DataStream index. <br /></td></tr>
<tr class="separator:a550bbb6e6a7419f440030f4b015fe875"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2692e7d4258bee2ceb82cb544a224940"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2692e7d4258bee2ceb82cb544a224940"></a>
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a2692e7d4258bee2ceb82cb544a224940">temp_dir</a></td></tr>
<tr class="memdesc:a2692e7d4258bee2ceb82cb544a224940"><td class="mdescLeft"> </td><td class="mdescRight">Temp directory managed by the session. <br /></td></tr>
<tr class="separator:a2692e7d4258bee2ceb82cb544a224940"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a720b62ae5a7af962000e724cff231bab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a720b62ae5a7af962000e724cff231bab"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a720b62ae5a7af962000e724cff231bab">target_dir</a></td></tr>
<tr class="memdesc:a720b62ae5a7af962000e724cff231bab"><td class="mdescLeft"> </td><td class="mdescRight">Target directory for current split. <br /></td></tr>
<tr class="separator:a720b62ae5a7af962000e724cff231bab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9289ec8d754e9bf8584fc3aa561f669e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9289ec8d754e9bf8584fc3aa561f669e"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a9289ec8d754e9bf8584fc3aa561f669e">datastream_id</a></td></tr>
<tr class="memdesc:a9289ec8d754e9bf8584fc3aa561f669e"><td class="mdescLeft"> </td><td class="mdescRight">ID of selected datastream. <br /></td></tr>
<tr class="separator:a9289ec8d754e9bf8584fc3aa561f669e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c763e4ef3ed922f625b575fb25ad2c2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c763e4ef3ed922f625b575fb25ad2c2"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a9c763e4ef3ed922f625b575fb25ad2c2">checklist_id</a></td></tr>
<tr class="memdesc:a9c763e4ef3ed922f625b575fb25ad2c2"><td class="mdescLeft"> </td><td class="mdescRight">ID of selected checklist. <br /></td></tr>
<tr class="separator:a9c763e4ef3ed922f625b575fb25ad2c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b83b713183dd716b0fae3fa03539ee4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b83b713183dd716b0fae3fa03539ee4"></a>
struct <a class="el" href="structoscap__htable.html">oscap_htable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__session.html#a7b83b713183dd716b0fae3fa03539ee4">component_sources</a></td></tr>
<tr class="memdesc:a7b83b713183dd716b0fae3fa03539ee4"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structoscap__source.html">oscap_source</a> for parsed components <br /></td></tr>
<tr class="separator:a7b83b713183dd716b0fae3fa03539ee4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0c409fcca09edfd11ad9872c33053cf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_session_dump_component_files </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store cached component files to the disc. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="a7b70f8b103148d0647bec2b740d50b62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ds_sds_session_get_checklist_id </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return ID of currently selected component representing XCCDF within the DataStream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ID of selected component or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="accb7b9c98985e22bc2252a58c4094d02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoscap__source.html">oscap_source</a> * ds_sds_session_get_component_by_href </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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>href</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get component from Source DataStream by its href. </p>
<p>This assumes that the component has been already cached by the session. You can cache component or its dependencies by calling ds_sds_session_select_checklist or ds_sds_session_register_component_with_dependencies. Returned <a class="el" href="structoscap__source.html">oscap_source</a> is owned by <a class="el" href="structds__sds__session.html">ds_sds_session</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session </td></tr>
<tr><td class="paramname">href</td><td>The href of the component. The href refers to either file name from the catalogue element or the target name provided previously by caller of upper mentioned functions. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structoscap__source.html">oscap_source</a> representing the component or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a25746017a38d1526a08b8bf80619415a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ds_sds_session_get_datastream_id </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return ID of currently selected DataStream within the DataStream collection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream sesssion </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ID of selected datastream or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a67ea437b89d70ac698dae9d9184eeb0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * ds_sds_session_get_html_guide </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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>Returns HTML representation of selected checklist in form of OpenSCAP guide. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session to generate guide from </td></tr>
<tr><td class="paramname">profile_id</td><td>ID of XCCDF profile within selected checklist to generate guide for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a buffer of HTML content that should be freed by the caller </dd></dl>
</div>
</div>
<a class="anchor" id="a3f193f4e340ddffeed214b40599dc29b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * ds_sds_session_get_sds_idx </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Source DataStream index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>Registry to query SDS index from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>source DataStream owned by session </dd></dl>
</div>
</div>
<a class="anchor" id="a020c2556fea93234fc8c57497532691e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * ds_sds_session_new_from_source </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new <a class="el" href="structds__sds__session.html">ds_sds_session</a> from existing <a class="el" href="structoscap__source.html">oscap_source</a>. </p>
<p>This assumes that the given <a class="el" href="structoscap__source.html">oscap_source</a> represents source DataStream. This function does not own the <a class="el" href="structoscap__source.html">oscap_source</a>, but it needs it for operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> representing a source datastream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created <a class="el" href="structds__sds__session.html">ds_sds_session</a> structure </dd></dl>
</div>
</div>
<a class="anchor" id="a9ac7c69740576cc687e9a0e975306b80"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_session_register_component_with_dependencies </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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>container_name</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 class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target_filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register component and its dependencies to internal cache. </p>
<p>This functions extracts component from selected datastream within collection and all it dependencies. The components may be later queried by ds_sds_session_get_component_by_href.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session </td></tr>
<tr><td class="paramname">container_name</td><td>The name of container like: "checks", "checklists", or "dictionaries". </td></tr>
<tr><td class="paramname">component_id</td><td>Id of component within selected datastream </td></tr>
<tr><td class="paramname">target</td><td>filename or NULL </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="a8c7bd0e96cfa68a85886e727ee3f84b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ds_sds_session_reset </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_session</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset session for further use. </p>
<p>Rationale: The <a class="el" href="structds__sds__session.html">ds_sds_session</a> is not versatile structure that would allow to work with all the DataStream content at once. The <a class="el" href="structds__sds__session.html">ds_sds_session</a> structure remembers certain selections like: selected datastream within collection, selected checklist, and cached catalogue files. If caller wants to open different checklist with different catalogue, they need to reset the session.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session to reset </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4fd5b896505bf2a770868fcd1fd0096d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoscap__source.html">oscap_source</a> * ds_sds_session_select_checklist </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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 class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>component_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>benchmark_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Select Checklist (XCCDF presumably) from DataStream collection. </p>
<p>Parameters may be skipped (passing NULL) to let the <a class="el" href="structds__sds__session.html">ds_sds_session</a> guess them.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>Source DataStream session to choose from </td></tr>
<tr><td class="paramname">datastream_id</td><td>ID of DataStream within collection </td></tr>
<tr><td class="paramname">component_id</td><td>ID of (XCCDF) checklist within datastream </td></tr>
<tr><td class="paramname">benchmark_id</td><td>ID of Benchmark element within checklist </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XCCDF checklist in form of <a class="el" href="structoscap__source.html">oscap_source</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab7880cbd613a5fb9fd4db032b0ba580a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoscap__source.html">oscap_source</a> * ds_sds_session_select_tailoring </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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>Select XCCDF Tailoring from DataStream collection. </p>
<p>The ds_sds_session_select_checklist needs to be called first. To determine what datastream should be used within collection.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>Source DataStream session to choose from </td></tr>
<tr><td class="paramname">component_id</td><td>ID of tailoring file within checklist container </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XCCdF tailoring in form of <a class="el" href="structoscap__source.html">oscap_source</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aab836184837ed2ffe1bcdb1f48a37615"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_session_set_datastream_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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 the ID of DataStream within collection to use. </p>
<p>Note that ds_sds_session_select_checklist may set this automatically.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>Source DataStream session </td></tr>
<tr><td class="paramname">datastream_id</td><td>DataStream ID to set </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="a78cdf7f25a71ed91728f796b4d7fdaeb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_session_set_target_dir </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__session.html">ds_sds_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>target_dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set target directory for the component files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The Source DataStream session </td></tr>
<tr><td class="paramname">target_dir</td><td>Path to the target storage dir </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>ds_sds_session.c</li>
<li><a class="el" href="ds__sds__session_8h_source.html">ds_sds_session.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>