| Current File : //usr/share/docs/openscap/html/structoscap__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: oscap_source Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">oscap_source Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a91574fc9136300d0f6cb3701a683768f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a91574fc9136300d0f6cb3701a683768f">oscap_source_new_from_xmlDoc</a> (xmlDoc *doc, const char *<a class="el" href="structoscap__source.html#a76b9bd3e067a60fbe5510a96989f904a">filepath</a>)</td></tr>
<tr class="memdesc:a91574fc9136300d0f6cb3701a683768f"><td class="mdescLeft"> </td><td class="mdescRight">Build new <a class="el" href="structoscap__source.html">oscap_source</a> from existing xmlDoc. <a href="#a91574fc9136300d0f6cb3701a683768f">More...</a><br /></td></tr>
<tr class="separator:a91574fc9136300d0f6cb3701a683768f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99f1088a6afff36cededd6485b591c35"><td class="memItemLeft" align="right" valign="top">xmlTextReader * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a99f1088a6afff36cededd6485b591c35">oscap_source_get_xmlTextReader</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:a99f1088a6afff36cededd6485b591c35"><td class="mdescLeft"> </td><td class="mdescRight">Get an xmlTextReader assigned with this resource. <a href="#a99f1088a6afff36cededd6485b591c35">More...</a><br /></td></tr>
<tr class="separator:a99f1088a6afff36cededd6485b591c35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c7960307ee5ef0cf0442a27ece5b82d"><td class="memItemLeft" align="right" valign="top">xmlDoc * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a2c7960307ee5ef0cf0442a27ece5b82d">oscap_source_get_xmlDoc</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:a2c7960307ee5ef0cf0442a27ece5b82d"><td class="mdescLeft"> </td><td class="mdescRight">Get a DOM representation of this resource. <a href="#a2c7960307ee5ef0cf0442a27ece5b82d">More...</a><br /></td></tr>
<tr class="separator:a2c7960307ee5ef0cf0442a27ece5b82d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa98424428d864394cfaec5207264b705"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#aa98424428d864394cfaec5207264b705">oscap_source_get_scap_type</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:aa98424428d864394cfaec5207264b705"><td class="mdescLeft"> </td><td class="mdescRight">Get SCAP document type of the given resource. <a href="#aa98424428d864394cfaec5207264b705">More...</a><br /></td></tr>
<tr class="separator:aa98424428d864394cfaec5207264b705"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedc10bab5b32e7136578fd29fee95973"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#aedc10bab5b32e7136578fd29fee95973">oscap_source_get_schema_version</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:aedc10bab5b32e7136578fd29fee95973"><td class="mdescLeft"> </td><td class="mdescRight">Get the version of the schema for the particular document type. <a href="#aedc10bab5b32e7136578fd29fee95973">More...</a><br /></td></tr>
<tr class="separator:aedc10bab5b32e7136578fd29fee95973"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a429a425e7c1ba8b0f2bd3582512f5a6d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a429a425e7c1ba8b0f2bd3582512f5a6d">oscap_source_validate</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source, xml_reporter <a class="el" href="structreporter.html">reporter</a>, void *user)</td></tr>
<tr class="memdesc:a429a425e7c1ba8b0f2bd3582512f5a6d"><td class="mdescLeft"> </td><td class="mdescRight">Validate the SCAP document against particular XML schema definition. <a href="#a429a425e7c1ba8b0f2bd3582512f5a6d">More...</a><br /></td></tr>
<tr class="separator:a429a425e7c1ba8b0f2bd3582512f5a6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26cb3dc5aef46c193875934a3c0ed047"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a26cb3dc5aef46c193875934a3c0ed047">oscap_source_validate_schematron</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source, const char *outfile)</td></tr>
<tr class="memdesc:a26cb3dc5aef46c193875934a3c0ed047"><td class="mdescLeft"> </td><td class="mdescRight">Validate the SCAP document against schematron assertions. <a href="#a26cb3dc5aef46c193875934a3c0ed047">More...</a><br /></td></tr>
<tr class="separator:a26cb3dc5aef46c193875934a3c0ed047"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d4ee1bb74d4860d7a80b5413f76b951"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a4d4ee1bb74d4860d7a80b5413f76b951">oscap_source_readable_origin</a> (const struct <a class="el" href="structoscap__source.html">oscap_source</a> *source)</td></tr>
<tr class="memdesc:a4d4ee1bb74d4860d7a80b5413f76b951"><td class="mdescLeft"> </td><td class="mdescRight">Returns human readable description of <a class="el" href="structoscap__source.html">oscap_source</a> origin. <a href="#a4d4ee1bb74d4860d7a80b5413f76b951">More...</a><br /></td></tr>
<tr class="separator:a4d4ee1bb74d4860d7a80b5413f76b951"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b62bdcf30b7e0b132daa25f352a4b36"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a4b62bdcf30b7e0b132daa25f352a4b36">oscap_source_save_as</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source, const char *filename)</td></tr>
<tr class="memdesc:a4b62bdcf30b7e0b132daa25f352a4b36"><td class="mdescLeft"> </td><td class="mdescRight">Store the resource represented by <a class="el" href="structoscap__source.html">oscap_source</a> to the file. <a href="#a4b62bdcf30b7e0b132daa25f352a4b36">More...</a><br /></td></tr>
<tr class="separator:a4b62bdcf30b7e0b132daa25f352a4b36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a601a2a63400dfaf4643ed77d43e1ca56"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a601a2a63400dfaf4643ed77d43e1ca56">oscap_source_apply_xslt_path</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source, const char *xsltfile, const char *outfile, const char **params, const char *path_to_xslt)</td></tr>
<tr class="memdesc:a601a2a63400dfaf4643ed77d43e1ca56"><td class="mdescLeft"> </td><td class="mdescRight">Apply stylesheet on XML file (represented by <a class="el" href="structoscap__source.html">oscap_source</a> structure). <a href="#a601a2a63400dfaf4643ed77d43e1ca56">More...</a><br /></td></tr>
<tr class="separator:a601a2a63400dfaf4643ed77d43e1ca56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35b643e876574617dcf59870b1f2afb1"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a35b643e876574617dcf59870b1f2afb1">oscap_source_apply_xslt_path_mem</a> (struct <a class="el" href="structoscap__source.html">oscap_source</a> *source, const char *xsltfile, const char **params, const char *path_to_xslt)</td></tr>
<tr class="memdesc:a35b643e876574617dcf59870b1f2afb1"><td class="mdescLeft"> </td><td class="mdescRight">Apply stylesheet on XML file (represented by <a class="el" href="structoscap__source.html">oscap_source</a> structure). <a href="#a35b643e876574617dcf59870b1f2afb1">More...</a><br /></td></tr>
<tr class="separator:a35b643e876574617dcf59870b1f2afb1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a07963f72def9e0c777108a02d7e9b532"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07963f72def9e0c777108a02d7e9b532"></a>
<a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__source.html#a07963f72def9e0c777108a02d7e9b532">scap_type</a></td></tr>
<tr class="memdesc:a07963f72def9e0c777108a02d7e9b532"><td class="mdescLeft"> </td><td class="mdescRight">Type of SCAP document (XCCDF, OVAL, ...) <br /></td></tr>
<tr class="separator:a07963f72def9e0c777108a02d7e9b532"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1efa682898328507472951e75cbdff83"><td class="memItemLeft" ><a class="anchor" id="a1efa682898328507472951e75cbdff83"></a>
struct {</td></tr>
<tr class="memitem:a7dfee2062c9f2683cadb64085b8d602e"><td class="memItemLeft" >
   oscap_source_type_t   <a class="el" href="structoscap__source.html#a8f9d1394c7dcfc5289a6e8043ba42cbc">type</a></td></tr>
<tr class="memdesc:a7dfee2062c9f2683cadb64085b8d602e"><td class="mdescLeft"> </td><td class="mdescRight">Internal type of the <a class="el" href="structoscap__source.html">oscap_source</a>. <br /></td></tr>
<tr class="separator:a7dfee2062c9f2683cadb64085b8d602e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae22a216666aff30f10699a68c235c5d0"><td class="memItemLeft" >
   char *   <a class="el" href="structoscap__source.html#ad4e584075855f5ab3774d1b0f53878c6">version</a></td></tr>
<tr class="memdesc:ae22a216666aff30f10699a68c235c5d0"><td class="mdescLeft"> </td><td class="mdescRight">Version of the particular document type. <br /></td></tr>
<tr class="separator:ae22a216666aff30f10699a68c235c5d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa8d35d05c0191bc4bb8b4ba16db354c"><td class="memItemLeft" >
   char *   <a class="el" href="structoscap__source.html#a76b9bd3e067a60fbe5510a96989f904a">filepath</a></td></tr>
<tr class="memdesc:aaa8d35d05c0191bc4bb8b4ba16db354c"><td class="mdescLeft"> </td><td class="mdescRight">Filepath (if originated from file) <br /></td></tr>
<tr class="separator:aaa8d35d05c0191bc4bb8b4ba16db354c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f42716a1e1bfa5cd275b469e9362cc7"><td class="memItemLeft" >
   char *   <a class="el" href="structoscap__source.html#a227d4087ec4f3906451ef4951ffa2a76">memory</a></td></tr>
<tr class="memdesc:a5f42716a1e1bfa5cd275b469e9362cc7"><td class="mdescLeft"> </td><td class="mdescRight">Memory buffer (if originated from memory) <br /></td></tr>
<tr class="separator:a5f42716a1e1bfa5cd275b469e9362cc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accd89debaa873789908bb165d3fc4cce"><td class="memItemLeft" >
   size_t   <a class="el" href="structoscap__source.html#af5c004ef5a507338229ab1574aed6d21">memory_size</a></td></tr>
<tr class="memdesc:accd89debaa873789908bb165d3fc4cce"><td class="mdescLeft"> </td><td class="mdescRight">Size of the memory buffer (if originated from memory) <br /></td></tr>
<tr class="separator:accd89debaa873789908bb165d3fc4cce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1efa682898328507472951e75cbdff83"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>origin</b></td></tr>
<tr class="separator:a1efa682898328507472951e75cbdff83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a779d769172bf258ddca18463909d4cd8"><td class="memItemLeft" ><a class="anchor" id="a779d769172bf258ddca18463909d4cd8"></a>
struct {</td></tr>
<tr class="memitem:a619bd906dfceb7f6b364c574aee4a9a0"><td class="memItemLeft" >
   xmlDoc *   <b>doc</b></td></tr>
<tr class="separator:a619bd906dfceb7f6b364c574aee4a9a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a779d769172bf258ddca18463909d4cd8"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>xml</b></td></tr>
<tr class="separator:a779d769172bf258ddca18463909d4cd8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a601a2a63400dfaf4643ed77d43e1ca56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oscap_source_apply_xslt_path </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xsltfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>outfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path_to_xslt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply stylesheet on XML file (represented by <a class="el" href="structoscap__source.html">oscap_source</a> structure). </p>
<p>If xsltfile is an absolute path to the stylesheet, path_to_xslt will not be used.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>oscap_surce structure representing file to transform </td></tr>
<tr><td class="paramname">xsltfile</td><td>absolute path to the stylesheet document or relative given the path_to_xslt </td></tr>
<tr><td class="paramname">outfile</td><td>output filename </td></tr>
<tr><td class="paramname">params</td><td>external params for xsl transformation </td></tr>
<tr><td class="paramname">path_to_xslt</td><td>optional path to xsl transformations </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="a35b643e876574617dcf59870b1f2afb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * oscap_source_apply_xslt_path_mem </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xsltfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path_to_xslt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply stylesheet on XML file (represented by <a class="el" href="structoscap__source.html">oscap_source</a> structure). </p>
<p>If xsltfile is an absolute path to the stylesheet, path_to_xslt will not be used.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>oscap_surce structure representing file to transform </td></tr>
<tr><td class="paramname">xsltfile</td><td>absolute path to the stylesheet document or relative given the path_to_xslt </td></tr>
<tr><td class="paramname">params</td><td>external params for xsl transformation </td></tr>
<tr><td class="paramname">path_to_xslt</td><td>optional path to xsl transformations </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly allocated buffer containing result of XSLT application. NULL is returned on error </dd></dl>
</div>
</div>
<a class="anchor" id="aa98424428d864394cfaec5207264b705"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> oscap_source_get_scap_type </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get SCAP document type of the given resource. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>determined document type</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function returns OSCAP_DOCUMENT_UNKNOWN to signal an error. Not being able to determine a valid documnent type is treated as an error. </dd></dl>
</div>
</div>
<a class="anchor" id="aedc10bab5b32e7136578fd29fee95973"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * oscap_source_get_schema_version </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version of the schema for the particular document type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> to get the schema version from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the schema version </dd></dl>
</div>
</div>
<a class="anchor" id="a2c7960307ee5ef0cf0442a27ece5b82d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlDoc * oscap_source_get_xmlDoc </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a DOM representation of this resource. </p>
<p>The document ins still owned by <a class="el" href="structoscap__source.html">oscap_source</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>Resource to build DOM representation from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>xmlDoc structure to read the content </dd></dl>
</div>
</div>
<a class="anchor" id="a99f1088a6afff36cededd6485b591c35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlTextReader * oscap_source_get_xmlTextReader </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an xmlTextReader assigned with this resource. </p>
<p>The reader needs to be disposed by caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>Resource to read the content </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>xmlTextReader structure to read the content </dd></dl>
</div>
</div>
<a class="anchor" id="a91574fc9136300d0f6cb3701a683768f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoscap__source.html">oscap_source</a> * oscap_source_new_from_xmlDoc </td>
<td>(</td>
<td class="paramtype">xmlDoc * </td>
<td class="paramname"><em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filepath</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build new <a class="el" href="structoscap__source.html">oscap_source</a> from existing xmlDoc. </p>
<p>The xmlDoc becomes owned by <a class="el" href="structoscap__source.html">oscap_source</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">doc</td><td>XML DOM to build from </td></tr>
<tr><td class="paramname">filepath</td><td>Suggested filename for the file or NULL </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created <a class="el" href="structoscap__source.html">oscap_source</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4d4ee1bb74d4860d7a80b5413f76b951"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * oscap_source_readable_origin </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns human readable description of <a class="el" href="structoscap__source.html">oscap_source</a> origin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> to get readable source from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>human readable description </dd></dl>
</div>
</div>
<a class="anchor" id="a4b62bdcf30b7e0b132daa25f352a4b36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oscap_source_save_as </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the resource represented by <a class="el" href="structoscap__source.html">oscap_source</a> to the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> to save </td></tr>
<tr><td class="paramname">filename</td><td>The filename or NULL, the previously supplied name will be used if filename is NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 or -1 to indicate error </dd></dl>
</div>
</div>
<a class="anchor" id="a429a425e7c1ba8b0f2bd3582512f5a6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oscap_source_validate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xml_reporter </td>
<td class="paramname"><em>reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Validate the SCAP document against particular XML schema definition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> to validate </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The held resource has to be XML for this function to work. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 on pass; 1 on fail, and -1 on internal error </dd></dl>
</div>
</div>
<a class="anchor" id="a26cb3dc5aef46c193875934a3c0ed047"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oscap_source_validate_schematron </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__source.html">oscap_source</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>outfile</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Validate the SCAP document against schematron assertions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="structoscap__source.html">oscap_source</a> to validate </td></tr>
<tr><td class="paramname">outfile</td><td>path to out file containing errors, NULL for stdout </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The held resource has to be XML for this function to work. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 on pass; 1 on fail, and -1 on internal error </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>oscap_source.c</li>
<li><a class="el" href="oscap__source__priv_8h_source.html">oscap_source_priv.h</a></li>
<li><a class="el" href="oscap__source_8h_source.html">oscap_source.h</a></li>
<li><a class="el" href="xslt__priv_8h_source.html">xslt_priv.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>