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
|
<!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: oval_syschar Struct 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
</ul>
</div>
<div class="tabs">
<ul>
<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>
</div>
<div class="contents">
<h1>oval_syschar Struct Reference<br/>
<small>
[<a class="el" href="group__OVALSYS.html">OVALSYS</a>]</small>
</h1><!-- doxytag: class="oval_syschar" -->
<p>Characteristics bound to an Oval_object.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga26b6dd1dc1337ad091a7381fd39cd799"></a><!-- doxytag: member="oval_syschar::oval_syschar_new" ref="ga26b6dd1dc1337ad091a7381fd39cd799" args="(struct oval_syschar_model *, struct oval_object *)" -->
struct <a class="el" href="structoval__syschar.html">oval_syschar</a> * </td><td class="memItemRight" valign="bottom"><b>oval_syschar_new</b> (struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> *, struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__syschar.html">oval_syschar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga6415412edc540f73202c9552093e8301">oval_syschar_clone</a> (struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> *new_model, struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *old_syschar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga50aeb1489d363426c0fcee74f0142bb9"></a><!-- doxytag: member="oval_syschar::oval_syschar_free" ref="ga50aeb1489d363426c0fcee74f0142bb9" args="(struct oval_syschar *)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_free</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp6e47466b75bb957a603aa54c079ac8bf"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabcbd7bbe2af28f401338dc9e4853e1be"></a><!-- doxytag: member="oval_syschar::oval_syschar_add_variable_binding" ref="gabcbd7bbe2af28f401338dc9e4853e1be" args="(struct oval_syschar *, struct oval_variable_binding *)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_add_variable_binding</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *, struct <a class="el" href="structoval__variable__binding.html">oval_variable_binding</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga175d0c36e80feada9b5940037aeaac52"></a><!-- doxytag: member="oval_syschar::oval_syschar_set_flag" ref="ga175d0c36e80feada9b5940037aeaac52" args="(struct oval_syschar *model, oval_syschar_collection_flag_t flag)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_set_flag</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *model, <a class="el" href="group__OVALSYS.html#ga6ca9feb1c89087dbae7c7d3074a378c9">oval_syschar_collection_flag_t</a> flag)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3f339c44ae4bda8eca6d121be1a2081a"></a><!-- doxytag: member="oval_syschar::oval_syschar_set_object" ref="ga3f339c44ae4bda8eca6d121be1a2081a" args="(struct oval_syschar *, struct oval_object *)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_set_object</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *, struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa8ffc4b5646e26a8fd1bf889f6336f79"></a><!-- doxytag: member="oval_syschar::oval_syschar_add_sysdata" ref="gaa8ffc4b5646e26a8fd1bf889f6336f79" args="(struct oval_syschar *, struct oval_sysdata *)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_add_sysdata</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *, struct <a class="el" href="structoval__sysdata.html">oval_sysdata</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f9a6c539fe4661ed162708e1322345e"></a><!-- doxytag: member="oval_syschar::oval_syschar_add_message" ref="ga7f9a6c539fe4661ed162708e1322345e" args="(struct oval_syschar *syschar, struct oval_message *message)" -->
void </td><td class="memItemRight" valign="bottom"><b>oval_syschar_add_message</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar, struct <a class="el" href="structoval__message.html">oval_message</a> *message)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Getters</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpc9fd0bcb5385a65354c37f1bb504399d"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga689a43dbc2760246d3d5c53b4db12e3d"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_flag" ref="ga689a43dbc2760246d3d5c53b4db12e3d" args="(struct oval_syschar *)" -->
<a class="el" href="group__OVALSYS.html#ga6ca9feb1c89087dbae7c7d3074a378c9">oval_syschar_collection_flag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga689a43dbc2760246d3d5c53b4db12e3d">oval_syschar_get_flag</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristic flag. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0c72eeff03e93230e915f34acfac5ae4"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_messages" ref="ga0c72eeff03e93230e915f34acfac5ae4" args="(struct oval_syschar *)" -->
struct <a class="el" href="structoval__message__iterator.html">oval_message_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga0c72eeff03e93230e915f34acfac5ae4">oval_syschar_get_messages</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get messages bound to this system characteristic. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga75271cf87c92dda9633d1b0875bd5ac4"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_object" ref="ga75271cf87c92dda9633d1b0875bd5ac4" args="(struct oval_syschar *)" -->
struct <a class="el" href="structoval__object.html">oval_object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga75271cf87c92dda9633d1b0875bd5ac4">oval_syschar_get_object</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get object associated with this system characteristic. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5376f1d40f8bfba1e44ba0943fa4bdc5"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_variable_bindings" ref="ga5376f1d40f8bfba1e44ba0943fa4bdc5" args="(struct oval_syschar *)" -->
struct <br class="typebreak"/>
<a class="el" href="structoval__variable__binding__iterator.html">oval_variable_binding_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga5376f1d40f8bfba1e44ba0943fa4bdc5">oval_syschar_get_variable_bindings</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristic variable bindings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf19bcb77e6af5896e4e3b7305bebed19"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_sysdata" ref="gaf19bcb77e6af5896e4e3b7305bebed19" args="(struct oval_syschar *)" -->
struct <a class="el" href="structoval__sysdata__iterator.html">oval_sysdata_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#gaf19bcb77e6af5896e4e3b7305bebed19">oval_syschar_get_sysdata</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristic data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#gaacf50ef25b441c5f2bbbc7b05556fa3d">oval_syschar_is_locked</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the syschar instance is locked. <a href="group__OVALSYS.html#gaacf50ef25b441c5f2bbbc7b05556fa3d"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Evaluators</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0e2baee3c2910ebf52942b30e93ba998"></a><!-- doxytag: member="oval_syschar::oval_syschar_is_valid" ref="ga0e2baee3c2910ebf52942b30e93ba998" args="(struct oval_syschar *syschar)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga0e2baee3c2910ebf52942b30e93ba998">oval_syschar_is_valid</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the syschar instance is valid An <a class="el" href="structoval__syschar.html" title="Characteristics bound to an Oval_object.">oval_syschar</a> is valid if all the following are true</p>
<ul>
<li>The object attribute is valid</li>
<li>All included variable_bindings are valid</li>
<li>All included sysdata are valid. </li>
</ul>
<br/></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c60303771a746f82d2704d0eb0afd26"></a><!-- doxytag: member="oval_syschar::model" ref="a7c60303771a746f82d2704d0eb0afd26" args="" -->
struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * </td><td class="memItemRight" valign="bottom"><b>model</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc9214c0eb49784cdff4e4500556def7"></a><!-- doxytag: member="oval_syschar::flag" ref="acc9214c0eb49784cdff4e4500556def7" args="" -->
<a class="el" href="group__OVALSYS.html#ga6ca9feb1c89087dbae7c7d3074a378c9">oval_syschar_collection_flag_t</a> </td><td class="memItemRight" valign="bottom"><b>flag</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ea1eee36449e8c05a4b621d00a56617"></a><!-- doxytag: member="oval_syschar::messages" ref="a0ea1eee36449e8c05a4b621d00a56617" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>messages</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2efee5219ed219af70b05d0fb55cb5d6"></a><!-- doxytag: member="oval_syschar::object" ref="a2efee5219ed219af70b05d0fb55cb5d6" args="" -->
struct <a class="el" href="structoval__object.html">oval_object</a> * </td><td class="memItemRight" valign="bottom"><b>object</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8cfd1e99c042a559a5f2f267270787b"></a><!-- doxytag: member="oval_syschar::variable_bindings" ref="af8cfd1e99c042a559a5f2f267270787b" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>variable_bindings</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5b117715779a6c80a4ec41665abcde8"></a><!-- doxytag: member="oval_syschar::sysdata" ref="ae5b117715779a6c80a4ec41665abcde8" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>sysdata</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Characteristics bound to an Oval_object. </p>
<p>Instances of Oval_syschar provide relate an Oval_object and Oval_sysdata instances.</p>
<p>If an OVAL Object does not exist on the system, then an object is still provided but with the flag attribute set to 'does not exist' and with no reference child elements. This shows that the object was looked for but not found on the system. If no object element is written in this case, users of the system characteristics file will not know whether the object was not found or no attempt was made to collect it.</p>
<p>The flag attribute holds information regarding the outcome of the data collection. For example, if there was an error looking for items that match the object specification, then the flag would be 'error'. Please refer to the description of FlagEnumeration for details about the different flag values. </p>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/pvrabec/project/openscap/openscap-0.5.12/src/OVAL/<a class="el" href="oval__syschar_8c.html">oval_syschar.c</a></li>
<li>/home/pvrabec/project/openscap/openscap-0.5.12/src/OVAL/public/<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
