File: structoval__syschar.html

package info (click to toggle)
openscap 1.0.9-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 129,588 kB
  • ctags: 26,325
  • sloc: xml: 611,156; ansic: 90,367; sh: 26,693; makefile: 2,463; python: 804; perl: 445; cpp: 123
file content (166 lines) | stat: -rw-r--r-- 19,175 bytes parent folder | download
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
<!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: oval_syschar Struct 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">oval_syschar Struct Reference<div class="ingroups"><a class="el" href="group__OVALSYS.html">OVAL System Characteristics</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Characteristics bound to an Oval_object.  
 <a href="structoval__syschar.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ga26b6dd1dc1337ad091a7381fd39cd799"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga26b6dd1dc1337ad091a7381fd39cd799"></a>
struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *&#160;</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 class="separator:ga26b6dd1dc1337ad091a7381fd39cd799"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6415412edc540f73202c9552093e8301"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *&#160;</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 class="separator:ga6415412edc540f73202c9552093e8301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50aeb1489d363426c0fcee74f0142bb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga50aeb1489d363426c0fcee74f0142bb9"></a>
void&#160;</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 class="separator:ga50aeb1489d363426c0fcee74f0142bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr>
<tr class="memitem:gabcbd7bbe2af28f401338dc9e4853e1be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabcbd7bbe2af28f401338dc9e4853e1be"></a>
void&#160;</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 class="separator:gabcbd7bbe2af28f401338dc9e4853e1be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga175d0c36e80feada9b5940037aeaac52"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga175d0c36e80feada9b5940037aeaac52"></a>
void&#160;</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 class="separator:ga175d0c36e80feada9b5940037aeaac52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f339c44ae4bda8eca6d121be1a2081a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3f339c44ae4bda8eca6d121be1a2081a"></a>
void&#160;</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 class="separator:ga3f339c44ae4bda8eca6d121be1a2081a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10f8bfa6d3a8ee2408d9ccbbe6814e1e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga10f8bfa6d3a8ee2408d9ccbbe6814e1e">oval_syschar_get_variable_instance</a> (const struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar)</td></tr>
<tr class="memdesc:ga10f8bfa6d3a8ee2408d9ccbbe6814e1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the variable_instance attribute of the syschar.  <a href="group__OVALSYS.html#ga10f8bfa6d3a8ee2408d9ccbbe6814e1e">More...</a><br/></td></tr>
<tr class="separator:ga10f8bfa6d3a8ee2408d9ccbbe6814e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05150c22725cdadfe097f85079b9678e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga05150c22725cdadfe097f85079b9678e">oval_syschar_set_variable_instance</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar, int variable_instance_in)</td></tr>
<tr class="memdesc:ga05150c22725cdadfe097f85079b9678e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the variable_instance attribute of the syschar.  <a href="group__OVALSYS.html#ga05150c22725cdadfe097f85079b9678e">More...</a><br/></td></tr>
<tr class="separator:ga05150c22725cdadfe097f85079b9678e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac64c5e2cd5287d96a1989011afeba81d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac64c5e2cd5287d96a1989011afeba81d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>oval_syschar_add_sysitem</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *, struct <a class="el" href="structoval__sysitem.html">oval_sysitem</a> *)</td></tr>
<tr class="separator:gac64c5e2cd5287d96a1989011afeba81d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f9a6c539fe4661ed162708e1322345e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f9a6c539fe4661ed162708e1322345e"></a>
void&#160;</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 class="separator:ga7f9a6c539fe4661ed162708e1322345e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0aded11a96cac70a4a92f2affd34196a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0aded11a96cac70a4a92f2affd34196a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>oval_syschar_add_new_message</b> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *syschar, char *text, <a class="el" href="group__OVALSYS.html#ga8ee215c8a9e2910e0595d0d32af688bc">oval_message_level_t</a> level)</td></tr>
<tr class="separator:ga0aded11a96cac70a4a92f2affd34196a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Getters</div></td></tr>
<tr class="memitem:ga689a43dbc2760246d3d5c53b4db12e3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga689a43dbc2760246d3d5c53b4db12e3d"></a>
<a class="el" href="group__OVALSYS.html#ga6ca9feb1c89087dbae7c7d3074a378c9">oval_syschar_collection_flag_t</a>&#160;</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 class="memdesc:ga689a43dbc2760246d3d5c53b4db12e3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get system characteristic flag. <br/></td></tr>
<tr class="separator:ga689a43dbc2760246d3d5c53b4db12e3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c72eeff03e93230e915f34acfac5ae4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0c72eeff03e93230e915f34acfac5ae4"></a>
struct <a class="el" href="structoval__message__iterator.html">oval_message_iterator</a> *&#160;</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 class="memdesc:ga0c72eeff03e93230e915f34acfac5ae4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get messages bound to this system characteristic. <br/></td></tr>
<tr class="separator:ga0c72eeff03e93230e915f34acfac5ae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75271cf87c92dda9633d1b0875bd5ac4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga75271cf87c92dda9633d1b0875bd5ac4"></a>
struct <a class="el" href="structoval__object.html">oval_object</a> *&#160;</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 class="memdesc:ga75271cf87c92dda9633d1b0875bd5ac4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get object associated with this system characteristic. <br/></td></tr>
<tr class="separator:ga75271cf87c92dda9633d1b0875bd5ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5376f1d40f8bfba1e44ba0943fa4bdc5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5376f1d40f8bfba1e44ba0943fa4bdc5"></a>
struct <br class="typebreak"/>
<a class="el" href="structoval__variable__binding__iterator.html">oval_variable_binding_iterator</a> *&#160;</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 class="memdesc:ga5376f1d40f8bfba1e44ba0943fa4bdc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get system characteristic variable bindings. <br/></td></tr>
<tr class="separator:ga5376f1d40f8bfba1e44ba0943fa4bdc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga339bf10ccdf346d4c530b6dce3c35749"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga339bf10ccdf346d4c530b6dce3c35749"></a>
struct <a class="el" href="structoval__sysitem__iterator.html">oval_sysitem_iterator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALSYS.html#ga339bf10ccdf346d4c530b6dce3c35749">oval_syschar_get_sysitem</a> (struct <a class="el" href="structoval__syschar.html">oval_syschar</a> *)</td></tr>
<tr class="memdesc:ga339bf10ccdf346d4c530b6dce3c35749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get system characteristic data. <br/></td></tr>
<tr class="separator:ga339bf10ccdf346d4c530b6dce3c35749"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7c60303771a746f82d2704d0eb0afd26"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c60303771a746f82d2704d0eb0afd26"></a>
struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>model</b></td></tr>
<tr class="separator:a7c60303771a746f82d2704d0eb0afd26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc9214c0eb49784cdff4e4500556def7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc9214c0eb49784cdff4e4500556def7"></a>
<a class="el" href="group__OVALSYS.html#ga6ca9feb1c89087dbae7c7d3074a378c9">oval_syschar_collection_flag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>flag</b></td></tr>
<tr class="separator:acc9214c0eb49784cdff4e4500556def7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ea1eee36449e8c05a4b621d00a56617"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ea1eee36449e8c05a4b621d00a56617"></a>
struct <a class="el" href="structoval__collection.html">oval_collection</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>messages</b></td></tr>
<tr class="separator:a0ea1eee36449e8c05a4b621d00a56617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2efee5219ed219af70b05d0fb55cb5d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2efee5219ed219af70b05d0fb55cb5d6"></a>
struct <a class="el" href="structoval__object.html">oval_object</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>object</b></td></tr>
<tr class="separator:a2efee5219ed219af70b05d0fb55cb5d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8cfd1e99c042a559a5f2f267270787b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8cfd1e99c042a559a5f2f267270787b"></a>
struct <a class="el" href="structoval__collection.html">oval_collection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__syschar.html#af8cfd1e99c042a559a5f2f267270787b">variable_bindings</a></td></tr>
<tr class="memdesc:af8cfd1e99c042a559a5f2f267270787b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents &lt;variable_value&gt; elements. <br/></td></tr>
<tr class="separator:af8cfd1e99c042a559a5f2f267270787b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d6eddbb386fdc3cef34d82bfa23a41d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d6eddbb386fdc3cef34d82bfa23a41d"></a>
struct <a class="el" href="structoval__collection.html">oval_collection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__syschar.html#a8d6eddbb386fdc3cef34d82bfa23a41d">sysitem</a></td></tr>
<tr class="memdesc:a8d6eddbb386fdc3cef34d82bfa23a41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents &lt;reference&gt; elements. <br/></td></tr>
<tr class="separator:a8d6eddbb386fdc3cef34d82bfa23a41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ababf3e4fb2925d0cbc18f99573db5ef2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ababf3e4fb2925d0cbc18f99573db5ef2"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__syschar.html#ababf3e4fb2925d0cbc18f99573db5ef2">variable_instance</a></td></tr>
<tr class="memdesc:ababf3e4fb2925d0cbc18f99573db5ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents variable_instance attribute. <br/></td></tr>
<tr class="separator:ababf3e4fb2925d0cbc18f99573db5ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ac7021f5688c7089449c4a6082c651f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ac7021f5688c7089449c4a6082c651f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__syschar.html#a7ac7021f5688c7089449c4a6082c651f">variable_instance_hint</a></td></tr>
<tr class="memdesc:a7ac7021f5688c7089449c4a6082c651f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal hint of the next possible variable_instance attribute. <br/></td></tr>
<tr class="separator:a7ac7021f5688c7089449c4a6082c651f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Characteristics bound to an Oval_object. </p>
<p>Instances of Oval_syschar provide relate an Oval_object and Oval_sysitem 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>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="oval__syschar_8c.html">oval_syschar.c</a></li>
<li><a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>