<!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: Common</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Common</div> </div>
</div>
<div class="contents">
<p>Definitions and functions common to all the OpenScap sublibraries.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html">Iterators & collections</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Iterators concept. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html">String manipulation</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Functions to access and manipulate textual data. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html">Validation</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>XML schema based validation of XML representations of SCAP documents. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html">Errors</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Error checking mechanism. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Reporters.html">Reporters</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Reporting mechanism. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html">Debug</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Debuging mechanism. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Memory.html">Memory</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Memory allocation wrapper functions used in library. </p>
<br/></td></tr>
</p>
<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="#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="#gad47f11d32a4245a127c078d52269312c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01435a7960889179bcedbfafaae5a097"></a><!-- doxytag: member="COMMON::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 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="COMMON::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="COMMON::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="COMMON::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>
<p>Definitions and functions common to all the OpenScap sublibraries. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gad47f11d32a4245a127c078d52269312c"></a><!-- doxytag: member="oscap.h::oscap_cleanup" ref="gad47f11d32a4245a127c078d52269312c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oscap_cleanup </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release library internal caches. </p>
<p>This function should be called once you finish working with any of the libraries included in OpenScap framework. It frees internally allocated memory, e.g. cache of the XML parser. </p>
</div>
</div>
<a class="anchor" id="ga732247519dc74a72214c7d8c7ea65a52"></a><!-- doxytag: member="oscap.h::oscap_init" ref="ga732247519dc74a72214c7d8c7ea65a52" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oscap_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize OpenSCAP library. </p>
<p>This is currently needed only in multithreaded applications (needs to be called before any child threads are spawned) or applications using the XSLT facility w/ EXSLT extensions. However, it is a good practice to call this function always at the beginning of the program execution. </p>
</div>
</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>
