<!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"/>
<title>Open SCAP Library: /home/pvrabec/project/openscap/openscap-0.7.4/src/common/public/oscap.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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>
<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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">/home/pvrabec/project/openscap/openscap-0.7.4/src/common/public/oscap.h File Reference</div> </div>
</div>
<div class="contents">
<p>General OpenScap functions and types.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdbool.h></code><br/>
<code>#include <wchar.h></code><br/>
<code>#include "<a class="el" href="text_8h_source.html">text.h</a>"</code><br/>
<code>#include "reference.h"</code><br/>
<code>#include "<a class="el" href="reporter_8h_source.html">reporter.h</a>"</code><br/>
</div>
<p><a href="oscap_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c">OSCAP_FOREACH_GENERIC</a>(itype, vtype, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">OSCAP_FOREACH</a>(type, val, init_val, code)   OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gafdd9cc9b1ae693c07dd4ff9727cfb019">OSCAP_FOREACH_STR</a>(val, init_val, code)   OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="group__ITER.html#gafdd9cc9b1ae693c07dd4ff9727cfb019"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69">OSCAP_FOR_GENERIC</a>(itype, vtype, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga4531eed65f8744afef6718920525395c">OSCAP_FOR</a>(type, val, init_val)   OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="group__ITER.html#ga4531eed65f8744afef6718920525395c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga9f9c24f232e5ad2aeeeed602b7b0008c">OSCAP_FOR_STR</a>(val, init_val)   OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="group__ITER.html#ga9f9c24f232e5ad2aeeeed602b7b0008c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac979f1141240cd8d0a762a2be9341965"></a><!-- doxytag: member="oscap.h::oscap_document_type_t" ref="gac979f1141240cd8d0a762a2be9341965" args="" -->
typedef enum <a class="el" href="group__VALID.html#gae11fc65de255d812d72c1f563146200f">oscap_document_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">SCAP document type identifiers. <br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gae11fc65de255d812d72c1f563146200f">oscap_document_type</a> { <br/>
  <a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fafc43196d876e7510c731e9329268b270">OSCAP_DOCUMENT_OVAL_DEFINITIONS</a> = 1,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa1beeca5febf1d503ef68b382a515ac0a">OSCAP_DOCUMENT_OVAL_VARIABLES</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fae8e342ea95744c96444f967671f19fa6">OSCAP_DOCUMENT_OVAL_SYSCHAR</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200faf668682d31530ba654ad6a501ff2c558">OSCAP_DOCUMENT_OVAL_RESULTS</a>,
<br/>
  <a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa3f530686b986be0046ea4b043a3c0ade">OSCAP_DOCUMENT_XCCDF</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200faae51c5951377f65c31e676fdd2e7acf0">OSCAP_DOCUMENT_CPE_LANGUAGE</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa2a2868aeedeafe930100ee5b7695d75f">OSCAP_DOCUMENT_CPE_DICTIONARY</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">SCAP document type identifiers. <a href="group__VALID.html#gae11fc65de255d812d72c1f563146200f">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga732247519dc74a72214c7d8c7ea65a52">oscap_init</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize OpenSCAP library. <a href="group__COMMON.html#ga732247519dc74a72214c7d8c7ea65a52"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#gad47f11d32a4245a127c078d52269312c">oscap_cleanup</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release library internal caches. <a href="group__COMMON.html#gad47f11d32a4245a127c078d52269312c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01435a7960889179bcedbfafaae5a097"></a><!-- doxytag: member="oscap.h::oscap_get_version" ref="ga01435a7960889179bcedbfafaae5a097" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga01435a7960889179bcedbfafaae5a097">oscap_get_version</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get version of the OpenSCAP library. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gac6aa74cf46267b053514f7579d010717">oscap_validate_document</a> (const char *xmlfile, <a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> doctype, const char *version, <a class="el" href="group__Reporters.html#gada96dbbbb54a7659c3acf1c00a7d7ad3">oscap_reporter</a> reporter, void *arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validate a SCAP document file against a XML schema. <a href="group__VALID.html#gac6aa74cf46267b053514f7579d010717"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#ga8c155b31c77a4e546a968321e140f671">oscap_apply_xslt</a> (const char *xmlfile, const char *xsltfile, const char *outfile, const char **params)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply a XSLT stylesheet to a XML file. <a href="group__VALID.html#ga8c155b31c77a4e546a968321e140f671"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gaca7e3b5061c71dfdd6f589fc2741b4e7">oscap_apply_xslt_var</a> (const char *xmlfile, const char *xsltfile, const char *outfile, const char **params, const char *pathvar, const char *defpath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply XSLT stylesheet to a XML file. <a href="group__VALID.html#gaca7e3b5061c71dfdd6f589fc2741b4e7"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga565da2b8c2c6394c634e3d9acb5a8c3a"></a><!-- doxytag: member="oscap.h::OSCAP_OS_PATH_DELIM" ref="ga565da2b8c2c6394c634e3d9acb5a8c3a" args="" -->
const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga565da2b8c2c6394c634e3d9acb5a8c3a">OSCAP_OS_PATH_DELIM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">OS-specific filesystem path delimiter. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeec1d42e5522500053c221de60e55b2c"></a><!-- doxytag: member="oscap.h::OSCAP_SCHEMA_PATH" ref="gaeec1d42e5522500053c221de60e55b2c" args="" -->
const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#gaeec1d42e5522500053c221de60e55b2c">OSCAP_SCHEMA_PATH</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default XML Schema path (if not overridden by the environment variable) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac6db487dff8c75b0e3af7de2ee4a1e0d"></a><!-- doxytag: member="oscap.h::OSCAP_XSLT_PATH" ref="gac6db487dff8c75b0e3af7de2ee4a1e0d" args="" -->
const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#gac6db487dff8c75b0e3af7de2ee4a1e0d">OSCAP_XSLT_PATH</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default XSLT path (if not overridden by the environment variable) <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>General OpenScap functions and types. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Lukas Kuklinek <<a href="mailto:lkuklinek@redhat.com">lkuklinek@redhat.com</a>> </dd></dl>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
