<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Open SCAP Library: ds_stream_index 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="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Open SCAP Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></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> </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_stream_index Struct Reference<div class="ingroups"><a class="el" href="group__DS.html">DS</a></div></div> </div> </div><!--header--> <div class="contents"> <p>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></p> <p><code>#include <<a class="el" href="scap__ds_8h_source.html">scap_ds.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></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_new</a> (void)</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_free</a> (struct <a class="el" href="structds__stream__index.html">ds_stream_index</a> *s)</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_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="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_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="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_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="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_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="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_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="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_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="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_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> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a76f57efa62b01f98c0f5bdc3829980d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76f57efa62b01f98c0f5bdc3829980d4"></a> char * </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr> <tr class="memitem:ae5615b423318238da6d5e29a7346f298"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5615b423318238da6d5e29a7346f298"></a> char * </td><td class="memItemRight" valign="bottom"><b>timestamp</b></td></tr> <tr class="memitem:ab7d6663761c3b899430c41f21957860c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7d6663761c3b899430c41f21957860c"></a> char * </td><td class="memItemRight" valign="bottom"><b>version</b></td></tr> <tr class="memitem:aa25020553d74882589e2c983dd78de07"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa25020553d74882589e2c983dd78de07"></a> struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </td><td class="memItemRight" valign="bottom"><b>check_components</b></td></tr> <tr class="memitem:a07fb05208cfe348cdf31958291ae3ac9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07fb05208cfe348cdf31958291ae3ac9"></a> struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </td><td class="memItemRight" valign="bottom"><b>checklist_components</b></td></tr> <tr class="memitem:a070aaa1801f7f3a5b20d1c0883b058af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a070aaa1801f7f3a5b20d1c0883b058af"></a> struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </td><td class="memItemRight" valign="bottom"><b>dictionary_components</b></td></tr> <tr class="memitem:ad31f45cf6d4083a8aa4905c1cd455c1a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad31f45cf6d4083a8aa4905c1cd455c1a"></a> struct <a class="el" href="structoscap__stringlist.html">oscap_stringlist</a> * </td><td class="memItemRight" valign="bottom"><b>extended_components</b></td></tr> <tr class="memitem:abe9920e08d2fd837b8f9829f6d4a3dfd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe9920e08d2fd837b8f9829f6d4a3dfd"></a> struct <a class="el" href="structoscap__htable.html">oscap_htable</a> * </td><td class="memItemRight" valign="bottom"><b>component_id_to_component_ref_id</b></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Contains information about one particular "<data-stream>" element in the datastream collection (also called SDS = source datastream). </p> <p>Is contained inside <a class="el" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a> which indexes the entire datastream collection.</p> <p>Only contains IDs, does not contain the data of components themselves! See ds_sds_decompose for that.</p> <p>Inside it are components divided into categories called "containers". These are "checks", "checklists", "dictionaries" and "extended-components". See the specification for more details about their meaning.</p> <dl class="section see"><dt>See also:</dt><dd><a class="el" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a> </dd></dl> </div><hr/>The documentation for this struct was generated from the following files:<ul> <li>sds_index.c</li> <li><a class="el" href="scap__ds_8h_source.html">scap_ds.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.1.1 </small></address> </body> </html>