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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<!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: Common</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Common</div> </div>
</div><!--header-->
<div class="contents">
<p>Definitions and functions common to all the OpenScap sublibraries.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__ITER"><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>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__STRINGS"><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>
<tr class="memdesc:group__STRINGS"><td class="mdescLeft"> </td><td class="mdescRight">Functions to access and manipulate textual data. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__VALID"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VALID.html">Validation</a></td></tr>
<tr class="memdesc:group__VALID"><td class="mdescLeft"> </td><td class="mdescRight">XML schema based validation of XML representations of SCAP documents. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__ERRORS"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERRORS.html">Errors</a></td></tr>
<tr class="memdesc:group__ERRORS"><td class="mdescLeft"> </td><td class="mdescRight">Error checking mechanism. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__Reporters"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Reporters.html">Reporters</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__Debug"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html">Debug</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__Memory"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Memory.html">Memory</a></td></tr>
<tr class="memdesc:group__Memory"><td class="mdescLeft"> </td><td class="mdescRight">Memory allocation wrapper functions used in library. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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="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="#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="#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:ga06a82d62cc239f077bc8188bd9a31dce"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMMON.html#ga06a82d62cc239f077bc8188bd9a31dce">oscap_textlist_get_preferred_plaintext</a> (struct <a class="el" href="structoscap__text__iterator.html">oscap_text_iterator</a> *texts, const char *preferred_lang)</td></tr>
<tr class="memdesc:ga06a82d62cc239f077bc8188bd9a31dce"><td class="mdescLeft"> </td><td class="mdescRight">gets a plaintext string representing given textlist <a href="#ga06a82d62cc239f077bc8188bd9a31dce">More...</a><br/></td></tr>
<tr class="separator:ga06a82d62cc239f077bc8188bd9a31dce"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Definitions and functions common to all the OpenScap sublibraries. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad47f11d32a4245a127c078d52269312c"></a>
<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>
<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>
<a class="anchor" id="ga06a82d62cc239f077bc8188bd9a31dce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* oscap_textlist_get_preferred_plaintext </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoscap__text__iterator.html">oscap_text_iterator</a> * </td>
<td class="paramname"><em>texts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>preferred_lang</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets a plaintext string representing given textlist </p>
<p>Iterates through given texts and looks at each to see if the language matches given preferred_lang. If preferred_lang is NULL, OSCAP_DEFAULT_LANG is matched.</p>
<p>If a match is found it, a copy of plaintext representation of that text is returned. If nothing is found, plaintext representation of the first text in the list is returned. If the textlist is empty, NULL is returned. </p>
</div>
</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>
|
