Current File : //usr/share/docs/openscap/html/ds__rds__session_8h_source.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_rds_session.h Source File</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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2602f4ddeed24e12bf976085a65cde76.html">DS</a></li><li class="navelem"><a class="el" href="dir_ba867982a4d200e2de341b2bac236905.html">public</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">ds_rds_session.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2014 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * Author:</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *     Šimon Lukašík</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#ifndef DS_RDS_SESSION_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#define DS_RDS_SESSION_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifdef HAVE_CONFIG_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;config.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="oscap_8h.html">oscap.h</a>&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;oscap_source.h&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="scap__ds_8h.html">scap_ds.h</a>&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">struct </span><a class="code" href="structds__rds__session.html">ds_rds_session</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">struct </span><a class="code" href="structds__rds__session.html">ds_rds_session</a> *<a class="code" href="structds__rds__session.html#a421c10b21f60429511a568d7c394d9b9">ds_rds_session_new_from_source</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *<a class="code" href="structds__rds__session.html#aa734d30158e97588ab88b3835aa3cab6">source</a>);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keywordtype">void</span> <a class="code" href="structds__rds__session.html#a5a17a6d58b7f8e75f6677ef4f370e783">ds_rds_session_free</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *rds_session);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keyword">struct </span><a class="code" href="structrds__index.html">rds_index</a> *<a class="code" href="structds__rds__session.html#ac879646b6c1dc0cd5310f1fff96f9f5a">ds_rds_session_get_rds_idx</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structds__rds__session.html#a52e2bf35350becebdaba2f947eeabade">ds_rds_session_set_target_dir</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session, <span class="keyword">const</span> <span class="keywordtype">char</span> *target_dir);</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structds__rds__session.html#ae7dce79f88a2664d154e3adcb4df2a7a">ds_rds_session_dump_component_files</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session);</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="keyword">struct </span><a class="code" href="structoscap__source.html">oscap_source</a> *<a class="code" href="structds__rds__session.html#a1ba7cb658ce764a1222c9c756dd6e54f">ds_rds_session_select_report</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session, <span class="keyword">const</span> <span class="keywordtype">char</span> *report_id);</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="keyword">struct </span><a class="code" href="structoscap__source.html">oscap_source</a> *<a class="code" href="structds__rds__session.html#a154b6558946434e65ee90ab57ec1baa5">ds_rds_session_select_report_request</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session, <span class="keyword">const</span> <span class="keywordtype">char</span> *report_request_id);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structds__rds__session.html#a6be045e9d45d32e1aedd8c37242c6c25">ds_rds_session_replace_report_with_source</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *session, <span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source);</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="keywordtype">char</span> *<a class="code" href="structds__rds__session.html#a957b90e51bf4fdffe79afcd52eb4c848">ds_rds_session_get_html_report</a>(<span class="keyword">struct</span> <a class="code" href="structds__rds__session.html">ds_rds_session</a> *rds_session);</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="oscap_8h_html"><div class="ttname"><a href="oscap_8h.html">oscap.h</a></div><div class="ttdoc">General OpenScap functions and types. </div></div>
<div class="ttc" id="structds__rds__session_html_a957b90e51bf4fdffe79afcd52eb4c848"><div class="ttname"><a href="structds__rds__session.html#a957b90e51bf4fdffe79afcd52eb4c848">ds_rds_session::ds_rds_session_get_html_report</a></div><div class="ttdeci">char * ds_rds_session_get_html_report(struct ds_rds_session *rds_session)</div><div class="ttdoc">Returns HTML representation of the given result datastream. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:178</div></div>
<div class="ttc" id="structds__rds__session_html_ae7dce79f88a2664d154e3adcb4df2a7a"><div class="ttname"><a href="structds__rds__session.html#ae7dce79f88a2664d154e3adcb4df2a7a">ds_rds_session::ds_rds_session_dump_component_files</a></div><div class="ttdeci">int ds_rds_session_dump_component_files(struct ds_rds_session *session)</div><div class="ttdoc">Store cached component files to the hard drive. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:118</div></div>
<div class="ttc" id="structds__rds__session_html_a6be045e9d45d32e1aedd8c37242c6c25"><div class="ttname"><a href="structds__rds__session.html#a6be045e9d45d32e1aedd8c37242c6c25">ds_rds_session::ds_rds_session_replace_report_with_source</a></div><div class="ttdeci">int ds_rds_session_replace_report_with_source(struct ds_rds_session *session, struct oscap_source *source)</div><div class="ttdoc">Replace currently selected report with the content of the source. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:160</div></div>
<div class="ttc" id="structds__rds__session_html_aa734d30158e97588ab88b3835aa3cab6"><div class="ttname"><a href="structds__rds__session.html#aa734d30158e97588ab88b3835aa3cab6">ds_rds_session::source</a></div><div class="ttdeci">struct oscap_source * source</div><div class="ttdoc">Result DataStream raw representation. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:43</div></div>
<div class="ttc" id="structds__rds__session_html"><div class="ttname"><a href="structds__rds__session.html">ds_rds_session</a></div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:42</div></div>
<div class="ttc" id="structds__rds__session_html_ac879646b6c1dc0cd5310f1fff96f9f5a"><div class="ttname"><a href="structds__rds__session.html#ac879646b6c1dc0cd5310f1fff96f9f5a">ds_rds_session::ds_rds_session_get_rds_idx</a></div><div class="ttdeci">struct rds_index * ds_rds_session_get_rds_idx(struct ds_rds_session *session)</div><div class="ttdoc">Get Result DataStream index. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:72</div></div>
<div class="ttc" id="structrds__index_html"><div class="ttname"><a href="structrds__index.html">rds_index</a></div><div class="ttdoc">Represents <asset-report-collection> element - the root element of each result datastream in Asset Re...</div><div class="ttdef"><b>Definition:</b> rds_index.c:198</div></div>
<div class="ttc" id="structoscap__source_html"><div class="ttname"><a href="structoscap__source.html">oscap_source</a></div><div class="ttdef"><b>Definition:</b> oscap_source.c:61</div></div>
<div class="ttc" id="structds__rds__session_html_a421c10b21f60429511a568d7c394d9b9"><div class="ttname"><a href="structds__rds__session.html#a421c10b21f60429511a568d7c394d9b9">ds_rds_session::ds_rds_session_new_from_source</a></div><div class="ttdeci">struct ds_rds_session * ds_rds_session_new_from_source(struct oscap_source *source)</div><div class="ttdoc">Create new ds_rds_session from existing oscap_source. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:50</div></div>
<div class="ttc" id="structds__rds__session_html_a52e2bf35350becebdaba2f947eeabade"><div class="ttname"><a href="structds__rds__session.html#a52e2bf35350becebdaba2f947eeabade">ds_rds_session::ds_rds_session_set_target_dir</a></div><div class="ttdeci">int ds_rds_session_set_target_dir(struct ds_rds_session *session, const char *target_dir)</div><div class="ttdoc">Set target directory for the component files. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:95</div></div>
<div class="ttc" id="structds__rds__session_html_a5a17a6d58b7f8e75f6677ef4f370e783"><div class="ttname"><a href="structds__rds__session.html#a5a17a6d58b7f8e75f6677ef4f370e783">ds_rds_session::ds_rds_session_free</a></div><div class="ttdeci">void ds_rds_session_free(struct ds_rds_session *rds_session)</div><div class="ttdoc">Dispose ds_rds_session structure. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:63</div></div>
<div class="ttc" id="structds__rds__session_html_a154b6558946434e65ee90ab57ec1baa5"><div class="ttname"><a href="structds__rds__session.html#a154b6558946434e65ee90ab57ec1baa5">ds_rds_session::ds_rds_session_select_report_request</a></div><div class="ttdeci">struct oscap_source * ds_rds_session_select_report_request(struct ds_rds_session *session, const char *report_request_id)</div><div class="ttdoc">Select arf:report-request from result DataStream and return it in form of oscap_source. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:139</div></div>
<div class="ttc" id="scap__ds_8h_html"><div class="ttname"><a href="scap__ds_8h.html">scap_ds.h</a></div><div class="ttdoc">Open-scap Data Stream interface. </div></div>
<div class="ttc" id="structds__rds__session_html_a1ba7cb658ce764a1222c9c756dd6e54f"><div class="ttname"><a href="structds__rds__session.html#a1ba7cb658ce764a1222c9c756dd6e54f">ds_rds_session::ds_rds_session_select_report</a></div><div class="ttdeci">struct oscap_source * ds_rds_session_select_report(struct ds_rds_session *session, const char *report_id)</div><div class="ttdoc">Select arf:report from result DataStream and return it in form of oscap_source. </div><div class="ttdef"><b>Definition:</b> ds_rds_session.c:123</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>