1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<!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.3.1"/>
<title>Open SCAP Library: oscap.h File 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.3.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><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 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_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li><li class="navelem"><a class="el" href="dir_02a00d8ef1b62c9e57160fe24bb0fab2.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">oscap.h File Reference</div> </div>
</div><!--header-->
<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="oscap__text_8h_source.html">oscap_text.h</a>"</code><br/>
<code>#include "oscap_reference.h"</code><br/>
</div>
<p><a href="oscap_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga87ad87a49af7d966b9a966e0fa260bc1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga87ad87a49af7d966b9a966e0fa260bc1"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga87ad87a49af7d966b9a966e0fa260bc1">OSCAP_DEPRECATED</a>(func)   func</td></tr>
<tr class="memdesc:ga87ad87a49af7d966b9a966e0fa260bc1"><td class="mdescLeft"> </td><td class="mdescRight">This macro will warn, when a deprecated function is used. <br/></td></tr>
<tr class="separator:ga87ad87a49af7d966b9a966e0fa260bc1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gac979f1141240cd8d0a762a2be9341965"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac979f1141240cd8d0a762a2be9341965"></a>
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 class="memdesc:gac979f1141240cd8d0a762a2be9341965"><td class="mdescLeft"> </td><td class="mdescRight">SCAP document type identifiers. <br/></td></tr>
<tr class="separator:gac979f1141240cd8d0a762a2be9341965"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga210767f8268bb4c91cd1cbf483a0da72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga210767f8268bb4c91cd1cbf483a0da72"></a>
typedef int(* </td><td class="memItemRight" valign="bottom"><b>xml_reporter</b> )(const char *file, int line, const char *msg, void *arg)</td></tr>
<tr class="separator:ga210767f8268bb4c91cd1cbf483a0da72"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gae11fc65de255d812d72c1f563146200f"><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#ggae11fc65de255d812d72c1f563146200fac6e0c570f97813e5c7413786bf40d425">OSCAP_DOCUMENT_OVAL_DIRECTIVES</a>,
<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/>
  <a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa828334bea80ec94d093251ec7d09c3c5">OSCAP_DOCUMENT_CVE_FEED</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa968fb0d69c5c33c3e324b1326a1ca1ee">OSCAP_DOCUMENT_SCE_RESULT</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200faaa595eb3a40fcf7c67106a9f3a92129f">OSCAP_DOCUMENT_SDS</a>,
<a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fa65908703eeff0a220e1ba25b8e0def7a">OSCAP_DOCUMENT_ARF</a>,
<br/>
  <a class="el" href="group__VALID.html#ggae11fc65de255d812d72c1f563146200fad98f3b3fe0b102359c31dc20879b2b2a">OSCAP_DOCUMENT_XCCDF_TAILORING</a>
<br/>
}</td></tr>
<tr class="memdesc:gae11fc65de255d812d72c1f563146200f"><td class="mdescLeft"> </td><td class="mdescRight">SCAP document type identifiers. <a href="group__VALID.html#gae11fc65de255d812d72c1f563146200f">More...</a><br/></td></tr>
<tr class="separator:gae11fc65de255d812d72c1f563146200f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga732247519dc74a72214c7d8c7ea65a52"><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 class="memdesc:ga732247519dc74a72214c7d8c7ea65a52"><td class="mdescLeft"> </td><td class="mdescRight">Initialize OpenSCAP library. <a href="group__COMMON.html#ga732247519dc74a72214c7d8c7ea65a52">More...</a><br/></td></tr>
<tr class="separator:ga732247519dc74a72214c7d8c7ea65a52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad47f11d32a4245a127c078d52269312c"><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 class="memdesc:gad47f11d32a4245a127c078d52269312c"><td class="mdescLeft"> </td><td class="mdescRight">Release library internal caches. <a href="group__COMMON.html#gad47f11d32a4245a127c078d52269312c">More...</a><br/></td></tr>
<tr class="separator:gad47f11d32a4245a127c078d52269312c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga01435a7960889179bcedbfafaae5a097"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01435a7960889179bcedbfafaae5a097"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga01435a7960889179bcedbfafaae5a097">oscap_get_version</a> (void)</td></tr>
<tr class="memdesc:ga01435a7960889179bcedbfafaae5a097"><td class="mdescLeft"> </td><td class="mdescRight">Get version of the OpenSCAP library. <br/></td></tr>
<tr class="separator:ga01435a7960889179bcedbfafaae5a097"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5b8f0b33aecd9f772af5be2c31c1037a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#ga5b8f0b33aecd9f772af5be2c31c1037a">oscap_document_type_to_string</a> (<a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> type)</td></tr>
<tr class="memdesc:ga5b8f0b33aecd9f772af5be2c31c1037a"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> constant to human readable (english) representation. <a href="group__VALID.html#ga5b8f0b33aecd9f772af5be2c31c1037a">More...</a><br/></td></tr>
<tr class="separator:ga5b8f0b33aecd9f772af5be2c31c1037a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb305adbb211169cf32a82cb3da0fdc4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gadb305adbb211169cf32a82cb3da0fdc4">oscap_validate_document</a> (const char *xmlfile, <a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> doctype, const char *version, xml_reporter <a class="el" href="structreporter.html">reporter</a>, void *arg)</td></tr>
<tr class="memdesc:gadb305adbb211169cf32a82cb3da0fdc4"><td class="mdescLeft"> </td><td class="mdescRight">Validate a SCAP document file against a XML schema. <a href="group__VALID.html#gadb305adbb211169cf32a82cb3da0fdc4">More...</a><br/></td></tr>
<tr class="separator:gadb305adbb211169cf32a82cb3da0fdc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa3ecdf745fed7ae87bb96ec13b362788"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gaa3ecdf745fed7ae87bb96ec13b362788">oscap_schematron_validate_document</a> (const char *xmlfile, <a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> doctype, const char *version, const char *outfile)</td></tr>
<tr class="memdesc:gaa3ecdf745fed7ae87bb96ec13b362788"><td class="mdescLeft"> </td><td class="mdescRight">Validate a SCAP document file against schematron rules. <a href="group__VALID.html#gaa3ecdf745fed7ae87bb96ec13b362788">More...</a><br/></td></tr>
<tr class="separator:gaa3ecdf745fed7ae87bb96ec13b362788"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab78e5df0e1b42faab2e6eae6af29f72e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gab78e5df0e1b42faab2e6eae6af29f72e">oscap_apply_xslt</a> (const char *xmlfile, const char *xsltfile, const char *outfile, const char **params)</td></tr>
<tr class="memdesc:gab78e5df0e1b42faab2e6eae6af29f72e"><td class="mdescLeft"> </td><td class="mdescRight">Apply a XSLT stylesheet to a XML file. <a href="group__VALID.html#gab78e5df0e1b42faab2e6eae6af29f72e">More...</a><br/></td></tr>
<tr class="separator:gab78e5df0e1b42faab2e6eae6af29f72e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf9afe0c57ada2e1e154869ef0de38c6f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf9afe0c57ada2e1e154869ef0de38c6f"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#gaf9afe0c57ada2e1e154869ef0de38c6f">oscap_path_to_schemas</a> (void)</td></tr>
<tr class="memdesc:gaf9afe0c57ada2e1e154869ef0de38c6f"><td class="mdescLeft"> </td><td class="mdescRight">Function returns path used to locate OpenSCAP XML schemas. <br/></td></tr>
<tr class="separator:gaf9afe0c57ada2e1e154869ef0de38c6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga25e09e72f9f3dc658f22dbfc5dcea6ea"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#ga25e09e72f9f3dc658f22dbfc5dcea6ea">oscap_path_to_schematron</a> (void)</td></tr>
<tr class="memdesc:ga25e09e72f9f3dc658f22dbfc5dcea6ea"><td class="mdescLeft"> </td><td class="mdescRight">Function returns path used to locate OpenSCAP Schematron files. <a href="group__VALID.html#ga25e09e72f9f3dc658f22dbfc5dcea6ea">More...</a><br/></td></tr>
<tr class="separator:ga25e09e72f9f3dc658f22dbfc5dcea6ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29b5ed02c5ca73f3bda847af54875da8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga29b5ed02c5ca73f3bda847af54875da8"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#ga29b5ed02c5ca73f3bda847af54875da8">oscap_path_to_cpe</a> (void)</td></tr>
<tr class="memdesc:ga29b5ed02c5ca73f3bda847af54875da8"><td class="mdescLeft"> </td><td class="mdescRight">Function returns path used to locate OpenSCAP Default CPE files. <br/></td></tr>
<tr class="separator:ga29b5ed02c5ca73f3bda847af54875da8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a27165df5c0839233b787a13fa3037f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1a27165df5c0839233b787a13fa3037f"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html#ga1a27165df5c0839233b787a13fa3037f">oscap_determine_document_type</a> (const char *document, <a class="el" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> *doc_type)</td></tr>
<tr class="memdesc:ga1a27165df5c0839233b787a13fa3037f"><td class="mdescLeft"> </td><td class="mdescRight">Determine document type. <br/></td></tr>
<tr class="separator:ga1a27165df5c0839233b787a13fa3037f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>General OpenScap functions and types. </p>
<dl class="section author"><dt>Author</dt><dd>Lukas Kuklinek <a href="#" onclick="location.href='mai'+'lto:'+'lku'+'kl'+'ine'+'k@'+'red'+'ha'+'t.c'+'om'; return false;">lkukl<span style="display: none;">.nosp@m.</span>inek<span style="display: none;">.nosp@m.</span>@redh<span style="display: none;">.nosp@m.</span>at.c<span style="display: none;">.nosp@m.</span>om</a> </dd></dl>
</div></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.3.1
</small></address>
</body>
</html>
|
