<!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.6"/>
<title>Open SCAP Library: DS</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.6 -->
<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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DS</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:scap__ds_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="scap__ds_8h.html">scap_ds.h</a></td></tr>
<tr class="memdesc:scap__ds_8h"><td class="mdescLeft"> </td><td class="mdescRight">Open-scap Data Stream interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="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="structds__stream__index.html">ds_stream_index</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains information about one particular "<data-stream>" element in the datastream collection (also called SDS = source datastream). <a href="structds__stream__index.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__sds__index.html">ds_sds_index</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents <data-stream-collection> element - the root element of each source datastream. <a href="structds__sds__index.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__report__request__index.html">rds_report_request_index</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__asset__index.html">rds_asset_index</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__report__index.html">rds_report_index</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrds__index.html">rds_index</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents <asset-report-collection> element - the root element of each result datastream in Asset Reporting Format = ARF. <a href="structrds__index.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac1c9f21670e515b210713a0130e4d25d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gac1c9f21670e515b210713a0130e4d25d">ds_sds_decompose</a> (const char *input_file, const char *id, const char *xccdf_id, const char *target_dir, const char *target_filename)</td></tr>
<tr class="memdesc:gac1c9f21670e515b210713a0130e4d25d"><td class="mdescLeft"> </td><td class="mdescRight">takes given source data stream and decomposes it into separate files <a href="#gac1c9f21670e515b210713a0130e4d25d">More...</a><br/></td></tr>
<tr class="separator:gac1c9f21670e515b210713a0130e4d25d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91b8af7a5474710bc420ddf930592622"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga91b8af7a5474710bc420ddf930592622">ds_sds_decompose_custom</a> (const char *input_file, const char *id, const char *target_dir, const char *container_name, const char *component_id, const char *target_filename)</td></tr>
<tr class="memdesc:ga91b8af7a5474710bc420ddf930592622"><td class="mdescLeft"> </td><td class="mdescRight">same as ds_sds_decompose but works with other components than just XCCDFs <a href="#ga91b8af7a5474710bc420ddf930592622">More...</a><br/></td></tr>
<tr class="separator:ga91b8af7a5474710bc420ddf930592622"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga958fcec57e9e60682d5ff9c52912a724"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga958fcec57e9e60682d5ff9c52912a724">ds_sds_compose_from_xccdf</a> (const char *xccdf_file, const char *target_datastream)</td></tr>
<tr class="memdesc:ga958fcec57e9e60682d5ff9c52912a724"><td class="mdescLeft"> </td><td class="mdescRight">takes given xccdf file and constructs a source datastream <a href="#ga958fcec57e9e60682d5ff9c52912a724">More...</a><br/></td></tr>
<tr class="separator:ga958fcec57e9e60682d5ff9c52912a724"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga601587bd53df79981bcb3c079a9f2519"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga601587bd53df79981bcb3c079a9f2519">ds_sds_compose_add_component</a> (const char *target_datastream, const char *datastream_id, const char *new_component, bool extended)</td></tr>
<tr class="memdesc:ga601587bd53df79981bcb3c079a9f2519"><td class="mdescLeft"> </td><td class="mdescRight">append a new given component to the existing source datastream <a href="#ga601587bd53df79981bcb3c079a9f2519">More...</a><br/></td></tr>
<tr class="separator:ga601587bd53df79981bcb3c079a9f2519"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a185d5d398fd558a543caa6e82ceec3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a185d5d398fd558a543caa6e82ceec3"></a>
int </td><td class="memItemRight" valign="bottom"><b>ds_rds_decompose</b> (const char *input_file, const char *report_id, const char *request_id, const char *target_dir)</td></tr>
<tr class="separator:ga9a185d5d398fd558a543caa6e82ceec3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga31bf69e775dee7bb0dc55bc533cc8e7b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga31bf69e775dee7bb0dc55bc533cc8e7b">ds_rds_create</a> (const char *sds_file, const char *xccdf_result_file, const char **oval_result_files, const char *target_file)</td></tr>
<tr class="memdesc:ga31bf69e775dee7bb0dc55bc533cc8e7b"><td class="mdescLeft"> </td><td class="mdescRight">takes given source data stream and XCCDF result file and makes a result data stream <a href="#ga31bf69e775dee7bb0dc55bc533cc8e7b">More...</a><br/></td></tr>
<tr class="separator:ga31bf69e775dee7bb0dc55bc533cc8e7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ae8ef1864feec0a5fbba8b8d8be3dd1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga9ae8ef1864feec0a5fbba8b8d8be3dd1">ds_sds_index_select_checklist</a> (struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> *s, const char **datastream_id, const char **component_id)</td></tr>
<tr class="memdesc:ga9ae8ef1864feec0a5fbba8b8d8be3dd1"><td class="mdescLeft"> </td><td class="mdescRight">chooses datastream and checklist id combination given the IDs <a href="#ga9ae8ef1864feec0a5fbba8b8d8be3dd1">More...</a><br/></td></tr>
<tr class="separator:ga9ae8ef1864feec0a5fbba8b8d8be3dd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f07357dd851a12b47e445a031dafd00"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga3f07357dd851a12b47e445a031dafd00">ds_sds_index_select_checklist_by_benchmark_id</a> (struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> *s, const char *benchmark_id, const char **datastream_id, const char **component_ref_id)</td></tr>
<tr class="memdesc:ga3f07357dd851a12b47e445a031dafd00"><td class="mdescLeft"> </td><td class="mdescRight">chooses datastream and checklist component ref ID combination, given benchmark ID <a href="#ga3f07357dd851a12b47e445a031dafd00">More...</a><br/></td></tr>
<tr class="separator:ga3f07357dd851a12b47e445a031dafd00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga095589a80fb3f96383ce6e683c1674fa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga095589a80fb3f96383ce6e683c1674fa"></a>
struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * </td><td class="memItemRight" valign="bottom"><b>rds_report_request_index_new</b> (void)</td></tr>
<tr class="separator:ga095589a80fb3f96383ce6e683c1674fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99a6638bafba1a9b88b25c5dc3dcd44d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga99a6638bafba1a9b88b25c5dc3dcd44d"></a>
void </td><td class="memItemRight" valign="bottom"><b>rds_report_request_index_free</b> (struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> *s)</td></tr>
<tr class="separator:ga99a6638bafba1a9b88b25c5dc3dcd44d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga63f83125bffe505a703d8d73db0d0c93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga63f83125bffe505a703d8d73db0d0c93"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>rds_report_request_index_get_id</b> (struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> *s)</td></tr>
<tr class="separator:ga63f83125bffe505a703d8d73db0d0c93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3802cc3071a2fec5276e8015b0cb6329"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3802cc3071a2fec5276e8015b0cb6329"></a>
struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> * </td><td class="memItemRight" valign="bottom"><b>rds_asset_index_new</b> (void)</td></tr>
<tr class="separator:ga3802cc3071a2fec5276e8015b0cb6329"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15c4c2d8b49b42fc764bca5b00c6a087"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga15c4c2d8b49b42fc764bca5b00c6a087"></a>
void </td><td class="memItemRight" valign="bottom"><b>rds_asset_index_free</b> (struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> *s)</td></tr>
<tr class="separator:ga15c4c2d8b49b42fc764bca5b00c6a087"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1be0048b7809f06a4150ece8d3331f17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1be0048b7809f06a4150ece8d3331f17"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>rds_asset_index_get_id</b> (struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> *s)</td></tr>
<tr class="separator:ga1be0048b7809f06a4150ece8d3331f17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0fc9929101dfb4adc62bc47a2f61b9a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0fc9929101dfb4adc62bc47a2f61b9a5"></a>
void </td><td class="memItemRight" valign="bottom"><b>rds_asset_index_add_report_ref</b> (struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> *s, struct <a class="el" href="structrds__report__index.html">rds_report_index</a> *report)</td></tr>
<tr class="separator:ga0fc9929101dfb4adc62bc47a2f61b9a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b790c5958b340ad1433c0b811875f0e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b790c5958b340ad1433c0b811875f0e"></a>
struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * </td><td class="memItemRight" valign="bottom"><b>rds_asset_index_get_reports</b> (struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> *s)</td></tr>
<tr class="separator:ga1b790c5958b340ad1433c0b811875f0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab72fa3977ae14a46870c39aa7053ac58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab72fa3977ae14a46870c39aa7053ac58"></a>
struct <a class="el" href="structrds__report__index.html">rds_report_index</a> * </td><td class="memItemRight" valign="bottom"><b>rds_report_index_new</b> (void)</td></tr>
<tr class="separator:gab72fa3977ae14a46870c39aa7053ac58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeda7210cc26e78f9424bc73eaf6fdd0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeda7210cc26e78f9424bc73eaf6fdd0a"></a>
void </td><td class="memItemRight" valign="bottom"><b>rds_report_index_free</b> (struct <a class="el" href="structrds__report__index.html">rds_report_index</a> *s)</td></tr>
<tr class="separator:gaeda7210cc26e78f9424bc73eaf6fdd0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ff4f506349f54b7cdd56baa72f8c504"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7ff4f506349f54b7cdd56baa72f8c504"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>rds_report_index_get_id</b> (struct <a class="el" href="structrds__report__index.html">rds_report_index</a> *s)</td></tr>
<tr class="separator:ga7ff4f506349f54b7cdd56baa72f8c504"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb7779ee8900c3faaf0f6586b71dd066"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabb7779ee8900c3faaf0f6586b71dd066"></a>
void </td><td class="memItemRight" valign="bottom"><b>rds_report_index_set_request</b> (struct <a class="el" href="structrds__report__index.html">rds_report_index</a> *s, struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> *request)</td></tr>
<tr class="separator:gabb7779ee8900c3faaf0f6586b71dd066"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e4e7feac46ffc76f29c1e40dce6cd20"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6e4e7feac46ffc76f29c1e40dce6cd20"></a>
struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * </td><td class="memItemRight" valign="bottom"><b>rds_report_index_get_request</b> (struct <a class="el" href="structrds__report__index.html">rds_report_index</a> *s)</td></tr>
<tr class="separator:ga6e4e7feac46ffc76f29c1e40dce6cd20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa61e25f2897a84bd5f73ac83bad81f35"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaa61e25f2897a84bd5f73ac83bad81f35">ds_stream_index::ds_stream_index_new</a> (void)</td></tr>
<tr class="separator:gaa61e25f2897a84bd5f73ac83bad81f35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3527d9341e1c22a3257d6452011e0ff3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga3527d9341e1c22a3257d6452011e0ff3">ds_stream_index::ds_stream_index_free</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="separator:ga3527d9341e1c22a3257d6452011e0ff3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21b2c036fcd648fb60afe2eae7fbe6fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga21b2c036fcd648fb60afe2eae7fbe6fe"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga21b2c036fcd648fb60afe2eae7fbe6fe">ds_stream_index::ds_stream_index_get_id</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:ga21b2c036fcd648fb60afe2eae7fbe6fe"><td class="mdescLeft"> </td><td class="mdescRight">Gets ID of the <data-stream> element the index represents. <br/></td></tr>
<tr class="separator:ga21b2c036fcd648fb60afe2eae7fbe6fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60ff80c354d57880c322fd29b1a2cad3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga60ff80c354d57880c322fd29b1a2cad3"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga60ff80c354d57880c322fd29b1a2cad3">ds_stream_index::ds_stream_index_get_timestamp</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:ga60ff80c354d57880c322fd29b1a2cad3"><td class="mdescLeft"> </td><td class="mdescRight">Timestamp of creation OR modification of the <data-stream> element the index represents. <br/></td></tr>
<tr class="separator:ga60ff80c354d57880c322fd29b1a2cad3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga552a53be748e1a6ab64f62197c9a49cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga552a53be748e1a6ab64f62197c9a49cf"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga552a53be748e1a6ab64f62197c9a49cf">ds_stream_index::ds_stream_index_get_version</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:ga552a53be748e1a6ab64f62197c9a49cf"><td class="mdescLeft"> </td><td class="mdescRight">scap-version of the the <data-stream> element the index represents. <br/></td></tr>
<tr class="separator:ga552a53be748e1a6ab64f62197c9a49cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa89d4716719b92c9be602789c0ab6246"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa89d4716719b92c9be602789c0ab6246"></a>
struct <a class="el" href="structoscap__string__iterator.html">oscap_string_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaa89d4716719b92c9be602789c0ab6246">ds_stream_index::ds_stream_index_get_checks</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:gaa89d4716719b92c9be602789c0ab6246"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves iterator over all components inside the <checks> element. <br/></td></tr>
<tr class="separator:gaa89d4716719b92c9be602789c0ab6246"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80fdc9afd11a6caa8fef301339090133"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga80fdc9afd11a6caa8fef301339090133"></a>
struct <a class="el" href="structoscap__string__iterator.html">oscap_string_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga80fdc9afd11a6caa8fef301339090133">ds_stream_index::ds_stream_index_get_checklists</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:ga80fdc9afd11a6caa8fef301339090133"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves iterator over all components inside the <checklists> element. <br/></td></tr>
<tr class="separator:ga80fdc9afd11a6caa8fef301339090133"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec7115cb582ba2ac73634a34a9a843cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaec7115cb582ba2ac73634a34a9a843cd"></a>
struct <a class="el" href="structoscap__string__iterator.html">oscap_string_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaec7115cb582ba2ac73634a34a9a843cd">ds_stream_index::ds_stream_index_get_dictionaries</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:gaec7115cb582ba2ac73634a34a9a843cd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves iterator over all components inside the <dictionaries> element. <br/></td></tr>
<tr class="separator:gaec7115cb582ba2ac73634a34a9a843cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga698025169a01226da062ac880f03b318"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga698025169a01226da062ac880f03b318"></a>
struct <a class="el" href="structoscap__string__iterator.html">oscap_string_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga698025169a01226da062ac880f03b318">ds_stream_index::ds_stream_index_get_extended_components</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</td></tr>
<tr class="memdesc:ga698025169a01226da062ac880f03b318"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves iterator over all components inside the <extended-components> element. <br/></td></tr>
<tr class="separator:ga698025169a01226da062ac880f03b318"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f61041d3e043f120d4c9ca7bb9943e9"><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__DS.html#ga0f61041d3e043f120d4c9ca7bb9943e9">ds_sds_index::ds_sds_index_new</a> (void)</td></tr>
<tr class="separator:ga0f61041d3e043f120d4c9ca7bb9943e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf9892255b4eebb1b0db65f6c1a988367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaf9892255b4eebb1b0db65f6c1a988367">ds_sds_index::ds_sds_index_free</a> (struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> *s)</td></tr>
<tr class="separator:gaf9892255b4eebb1b0db65f6c1a988367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a82a376e095479ecab0d2a421d38e47"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4a82a376e095479ecab0d2a421d38e47"></a>
struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga4a82a376e095479ecab0d2a421d38e47">ds_sds_index::ds_sds_index_get_stream</a> (struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> *s, const char *stream_id)</td></tr>
<tr class="memdesc:ga4a82a376e095479ecab0d2a421d38e47"><td class="mdescLeft"> </td><td class="mdescRight">retrieves a stream index by data-stream ID <br/></td></tr>
<tr class="separator:ga4a82a376e095479ecab0d2a421d38e47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga515b5d593a00f05bff7576107cc3ded3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga515b5d593a00f05bff7576107cc3ded3"></a>
struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga515b5d593a00f05bff7576107cc3ded3">ds_sds_index::ds_sds_index_get_streams</a> (struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> *s)</td></tr>
<tr class="memdesc:ga515b5d593a00f05bff7576107cc3ded3"><td class="mdescLeft"> </td><td class="mdescRight">retrieves all streams indexed inside this structure <br/></td></tr>
<tr class="separator:ga515b5d593a00f05bff7576107cc3ded3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6de056f9e4eeb1bd0a064954b7a5ee8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa6de056f9e4eeb1bd0a064954b7a5ee8"></a>
struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaa6de056f9e4eeb1bd0a064954b7a5ee8">ds_sds_index::ds_sds_index_import</a> (const char *file)</td></tr>
<tr class="memdesc:gaa6de056f9e4eeb1bd0a064954b7a5ee8"><td class="mdescLeft"> </td><td class="mdescRight">imports given source datastream and indexes it <br/></td></tr>
<tr class="separator:gaa6de056f9e4eeb1bd0a064954b7a5ee8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga86d6f16dbc87d982027adc3544d67114"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga86d6f16dbc87d982027adc3544d67114">ds_stream_index_iterator::ds_stream_index_iterator_next</a> (struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it)</td></tr>
<tr class="separator:ga86d6f16dbc87d982027adc3544d67114"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga25530912cfceaef0c7cc9e834ce85f09"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga25530912cfceaef0c7cc9e834ce85f09">ds_stream_index_iterator::ds_stream_index_iterator_has_more</a> (struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it)</td></tr>
<tr class="separator:ga25530912cfceaef0c7cc9e834ce85f09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab875fcb954ad3a869539e498c1a50fdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gab875fcb954ad3a869539e498c1a50fdc">ds_stream_index_iterator::ds_stream_index_iterator_free</a> (struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it)</td></tr>
<tr class="separator:gab875fcb954ad3a869539e498c1a50fdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad0366e7ca66c9226b1e3a68955b14e2f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gad0366e7ca66c9226b1e3a68955b14e2f">rds_report_request_index_iterator::rds_report_request_index_iterator_next</a> (struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> *it)</td></tr>
<tr class="separator:gad0366e7ca66c9226b1e3a68955b14e2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85bd267b3f9589cec1a939a113d72c55"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga85bd267b3f9589cec1a939a113d72c55">rds_report_request_index_iterator::rds_report_request_index_iterator_has_more</a> (struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> *it)</td></tr>
<tr class="separator:ga85bd267b3f9589cec1a939a113d72c55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga720f99c0fdec09c2bacae77fee2d4fba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga720f99c0fdec09c2bacae77fee2d4fba">rds_report_request_index_iterator::rds_report_request_index_iterator_free</a> (struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> *it)</td></tr>
<tr class="separator:ga720f99c0fdec09c2bacae77fee2d4fba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa428a44acaef09fd040c37f0bdd9af3b"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gaa428a44acaef09fd040c37f0bdd9af3b">rds_asset_index_iterator::rds_asset_index_iterator_next</a> (struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> *it)</td></tr>
<tr class="separator:gaa428a44acaef09fd040c37f0bdd9af3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac597f3ffe1590fedd6ee014b925dd491"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gac597f3ffe1590fedd6ee014b925dd491">rds_asset_index_iterator::rds_asset_index_iterator_has_more</a> (struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> *it)</td></tr>
<tr class="separator:gac597f3ffe1590fedd6ee014b925dd491"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab89862e957bcf6b95c0b0ba9fc4c7e37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gab89862e957bcf6b95c0b0ba9fc4c7e37">rds_asset_index_iterator::rds_asset_index_iterator_free</a> (struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> *it)</td></tr>
<tr class="separator:gab89862e957bcf6b95c0b0ba9fc4c7e37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e61bf394cc76676ac7f70e4075e8521"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__report__index.html">rds_report_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga6e61bf394cc76676ac7f70e4075e8521">rds_report_index_iterator::rds_report_index_iterator_next</a> (struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> *it)</td></tr>
<tr class="separator:ga6e61bf394cc76676ac7f70e4075e8521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae513d39ffce2fb99df0dad398f08921f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gae513d39ffce2fb99df0dad398f08921f">rds_report_index_iterator::rds_report_index_iterator_has_more</a> (struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> *it)</td></tr>
<tr class="separator:gae513d39ffce2fb99df0dad398f08921f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e95b84e41e38da7a72019390d77ab27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga7e95b84e41e38da7a72019390d77ab27">rds_report_index_iterator::rds_report_index_iterator_free</a> (struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> *it)</td></tr>
<tr class="separator:ga7e95b84e41e38da7a72019390d77ab27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga572ad91ce7f41fbcbfa12ede41eb0480"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__index.html">rds_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga572ad91ce7f41fbcbfa12ede41eb0480">rds_index::rds_index_new</a> (void)</td></tr>
<tr class="separator:ga572ad91ce7f41fbcbfa12ede41eb0480"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6dfb46aaf1bb638009eccad6d8509acd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga6dfb46aaf1bb638009eccad6d8509acd">rds_index::rds_index_free</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *s)</td></tr>
<tr class="separator:ga6dfb46aaf1bb638009eccad6d8509acd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga78fe7355bc71836804b528218d8f967a"><td class="memItemLeft" align="right" valign="top">struct <br class="typebreak"/>
<a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga78fe7355bc71836804b528218d8f967a">rds_index::rds_index_get_report_requests</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *s)</td></tr>
<tr class="separator:ga78fe7355bc71836804b528218d8f967a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6cf8bed7108bf02a8bd60671eea79530"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga6cf8bed7108bf02a8bd60671eea79530">rds_index::rds_index_get_assets</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *s)</td></tr>
<tr class="separator:ga6cf8bed7108bf02a8bd60671eea79530"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga734b0c259903bd157f2a5a773e753589"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga734b0c259903bd157f2a5a773e753589">rds_index::rds_index_get_reports</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *s)</td></tr>
<tr class="separator:ga734b0c259903bd157f2a5a773e753589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77ff52f9b205bad970c2bd0919a38503"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga77ff52f9b205bad970c2bd0919a38503">rds_index::rds_index_get_report_request</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *rds, const char *id)</td></tr>
<tr class="separator:ga77ff52f9b205bad970c2bd0919a38503"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga07cb39b1cf2a1ee2807bb5436f741396"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga07cb39b1cf2a1ee2807bb5436f741396">rds_index::rds_index_get_asset</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *rds, const char *id)</td></tr>
<tr class="separator:ga07cb39b1cf2a1ee2807bb5436f741396"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga375f0062b1cc0a1c7b3a9d085c0bb813"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__report__index.html">rds_report_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#ga375f0062b1cc0a1c7b3a9d085c0bb813">rds_index::rds_index_get_report</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *rds, const char *id)</td></tr>
<tr class="separator:ga375f0062b1cc0a1c7b3a9d085c0bb813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafd3c9fc1e05489d5f2259788ba1ccd39"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structrds__index.html">rds_index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gafd3c9fc1e05489d5f2259788ba1ccd39">rds_index::rds_index_import</a> (const char *file)</td></tr>
<tr class="separator:gafd3c9fc1e05489d5f2259788ba1ccd39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0013b343558ce719d787201de61ed43"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DS.html#gab0013b343558ce719d787201de61ed43">rds_index::rds_index_select_report</a> (struct <a class="el" href="structrds__index.html">rds_index</a> *s, const char **report_id)</td></tr>
<tr class="separator:gab0013b343558ce719d787201de61ed43"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga31bf69e775dee7bb0dc55bc533cc8e7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_rds_create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sds_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xccdf_result_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>oval_result_files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>takes given source data stream and XCCDF result file and makes a result data stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sds_file</td><td>Path to the source data stream file that was used to generate the result XCCDF</td></tr>
<tr><td class="paramname">xccdf_result_file</td><td>Contains xccdf:TestResult(s) and the embedded Benchmark (optionally). The embedded Benchmark (source data) will not be included in the result data stream, we will instead bundle the source data stream.</td></tr>
<tr><td class="paramname">oval_result_files</td><td>NULL terminated list of paths to OVAL result files that should be bundled in the result data stream.</td></tr>
<tr><td class="paramname">target_file</td><td>Path to the file where the result data stream will be stored</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no errors were encountered -1 in case of errors </dd></dl>
</div>
</div>
<a class="anchor" id="ga601587bd53df79981bcb3c079a9f2519"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_compose_add_component </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target_datastream</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>new_component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>extended</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>append a new given component to the existing source datastream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target_datastream</td><td>Path of the existing source datastream into which the new component shall be added.</td></tr>
<tr><td class="paramname">datastream_id</td><td>ID of the datastream into which the component shall be added. Null value indicates the very first datastream in the collection.</td></tr>
<tr><td class="paramname">new_component</td><td>Path to the new component file (XCCDF, OVAL, or CPE Dictionary).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success </dd></dl>
</div>
</div>
<a class="anchor" id="ga958fcec57e9e60682d5ff9c52912a724"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_compose_from_xccdf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xccdf_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target_datastream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>takes given xccdf file and constructs a source datastream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xccdf_file</td><td>Path to the XCCDF file that should be included in the datastream (including its dependencies).</td></tr>
<tr><td class="paramname">target_datastream</td><td>ID of the datastream that should contain the XCCDF file. It will be the only datastream in the resulting data-stream-collection.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no errors were encountered -1 in case of errors </dd></dl>
</div>
</div>
<a class="anchor" id="gac1c9f21670e515b210713a0130e4d25d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_decompose </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xccdf_id</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 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>takes given source data stream and decomposes it into separate files </p>
<p>This function bases the output on an XCCDF embedded in the "checklists" element in the datastream. Most of the times this is what everybody wants.</p>
<p>If you want to decompose just an OVAL file or some other custom behavior, see ds_sds_decompose_custom.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input_file</td><td>File containing a datastream collection we want to decompose parts from</td></tr>
<tr><td class="paramname">id</td><td>ID of a datastream we want to use from the given datastream collection. The first encountered datastream is used if id is NULL.</td></tr>
<tr><td class="paramname">xccdf_id</td><td>ID of the component containing the XCCDF we want to process. The first encountered XCCDF component is used if id is NULL.</td></tr>
<tr><td class="paramname">target_dir</td><td>Directory where the resulting files will be stored, names of the files are deduced using component-refs inside the datastream.</td></tr>
<tr><td class="paramname">target_filename</td><td>Base name of the target XCCDF file, if NULL is given the filename will be deduced from the contents of the datastream.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no errors were encountered -1 in case of errors </dd></dl>
</div>
</div>
<a class="anchor" id="ga91b8af7a5474710bc420ddf930592622"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_decompose_custom </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target_dir</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>same as ds_sds_decompose but works with other components than just XCCDFs </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>component reference container such as "checklists", "checks", ...</td></tr>
<tr><td class="paramname">component_id</td><td>id of the component you want to start the export from. If NULL, all components refs inside given container will be exported.</td></tr>
<tr><td class="paramname">target_filename</td><td>Base name of the target file, if NULL is given the filename will be deduced from the contents of the datastream.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__DS.html#gac1c9f21670e515b210713a0130e4d25d" title="takes given source data stream and decomposes it into separate files ">ds_sds_decompose</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf9892255b4eebb1b0db65f6c1a988367"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ds_sds_index_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga0f61041d3e043f120d4c9ca7bb9943e9"></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_index_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga9ae8ef1864feec0a5fbba8b8d8be3dd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_index_select_checklist </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td>
<td class="paramname"><em>s</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>chooses datastream and checklist id combination given the IDs </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">datastream_id</td><td>has to point to an allocated char*, selected datastream ID will be filled into it </td></tr>
<tr><td class="paramname">component_id</td><td>has to point to an allocated char*, selected xccdf ID will be filled into it</td></tr>
</table>
</dd>
</dl>
<p>datastream_id and component_id must not point to the same memory! However, the pointers pointed to may be NULL (which means any ID will do).</p>
<p>component_id is actually a component-ref ID, the reason is that we need the component-ref to know which other components are in the catalog and thus needed when splitting. </p>
</div>
</div>
<a class="anchor" id="ga3f07357dd851a12b47e445a031dafd00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ds_sds_index_select_checklist_by_benchmark_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__sds__index.html">ds_sds_index</a> * </td>
<td class="paramname"><em>s</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 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_ref_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>chooses datastream and checklist component ref ID combination, given benchmark ID </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">benchmark_id</td><td>Which XCCDF Benchmark ID are we looking for? Parameters are similar to ds_sds_index_select_checklist, except for benchmark_id. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__DS.html#ga9ae8ef1864feec0a5fbba8b8d8be3dd1" title="chooses datastream and checklist id combination given the IDs ">ds_sds_index_select_checklist</a></dd></dl>
<p>This function looks through to datastream index to find the first component-ref (top-down) which satisfies the following condition: "it does point to a component which contains XCCDF Benchmark with id
exactly the same as given benchmark_id".</p>
<p>Please note that datastream_id AND component_ref_id are pointers to pointers and they will be overwritten if 0 is returned. The values are never used, unlike with ds_sds_index_select_checklist. </p>
</div>
</div>
<a class="anchor" id="ga3527d9341e1c22a3257d6452011e0ff3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ds_stream_index_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gab875fcb954ad3a869539e498c1a50fdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ds_stream_index_iterator_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga25530912cfceaef0c7cc9e834ce85f09"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ds_stream_index_iterator_has_more </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga86d6f16dbc87d982027adc3544d67114"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * ds_stream_index_iterator_next </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gaa61e25f2897a84bd5f73ac83bad81f35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> * ds_stream_index_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gab89862e957bcf6b95c0b0ba9fc4c7e37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rds_asset_index_iterator_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gac597f3ffe1590fedd6ee014b925dd491"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rds_asset_index_iterator_has_more </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gaa428a44acaef09fd040c37f0bdd9af3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> * rds_asset_index_iterator_next </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6dfb46aaf1bb638009eccad6d8509acd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rds_index_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga07cb39b1cf2a1ee2807bb5436f741396"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__asset__index.html">rds_asset_index</a> * rds_index_get_asset </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>rds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6cf8bed7108bf02a8bd60671eea79530"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__asset__index__iterator.html">rds_asset_index_iterator</a> * rds_index_get_assets </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga375f0062b1cc0a1c7b3a9d085c0bb813"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__index.html">rds_report_index</a> * rds_index_get_report </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>rds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga77ff52f9b205bad970c2bd0919a38503"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * rds_index_get_report_request </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>rds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga78fe7355bc71836804b528218d8f967a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> * rds_index_get_report_requests </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga734b0c259903bd157f2a5a773e753589"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * rds_index_get_reports </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gafd3c9fc1e05489d5f2259788ba1ccd39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__index.html">rds_index</a> * rds_index_import </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga572ad91ce7f41fbcbfa12ede41eb0480"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__index.html">rds_index</a> * rds_index_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gab0013b343558ce719d787201de61ed43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rds_index_select_report </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__index.html">rds_index</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>report_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga7e95b84e41e38da7a72019390d77ab27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rds_report_index_iterator_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gae513d39ffce2fb99df0dad398f08921f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rds_report_index_iterator_has_more </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6e61bf394cc76676ac7f70e4075e8521"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__index.html">rds_report_index</a> * rds_report_index_iterator_next </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__index__iterator.html">rds_report_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga720f99c0fdec09c2bacae77fee2d4fba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rds_report_request_index_iterator_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga85bd267b3f9589cec1a939a113d72c55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rds_report_request_index_iterator_has_more </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gad0366e7ca66c9226b1e3a68955b14e2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structrds__report__request__index.html">rds_report_request_index</a> * rds_report_request_index_iterator_next </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrds__report__request__index__iterator.html">rds_report_request_index_iterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</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.6
</small></address>
</body>
</html>
distrib
>
Scientific%20Linux
>
5x
>
x86_64
>
by-pkgid
>
dcbb19bbc4636f73f405fbb232b0cc34
>
files
>
248
