File: structoval__variable.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 (159 lines) | stat: -rw-r--r-- 19,474 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
<!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_variable 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_variable Struct Reference<div class="ingroups"><a class="el" href="group__OVALDEF.html">OVAL Definitions</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>An oval variable resolves an <a class="el" href="structoval__value.html">oval_value</a> stream which specifies constraints for <a class="el" href="structoval__object.html">oval_object</a><b>s</b> and <a class="el" href="structoval__state.html">oval_state</a><b>s</b>.  
 <a href="structoval__variable.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="oval__definitions_8h_source.html">oval_definitions.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:gaf8e193bd514f8296466c3801bde2bb25"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__variable.html">oval_variable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaf8e193bd514f8296466c3801bde2bb25">oval_variable_new</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model, const char *id, <a class="el" href="group__OVALDEF.html#ga508c483d127b48e6190a40b401962db6">oval_variable_type_t</a> type)</td></tr>
<tr class="memdesc:gaf8e193bd514f8296466c3801bde2bb25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct new instance of <a class="el" href="structoval__variable.html">oval_variable</a>.  <a href="group__OVALDEF.html#gaf8e193bd514f8296466c3801bde2bb25">More...</a><br/></td></tr>
<tr class="separator:gaf8e193bd514f8296466c3801bde2bb25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga340cb9621c5af8d3e9ab6468cc1948e0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__variable.html">oval_variable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga340cb9621c5af8d3e9ab6468cc1948e0">oval_variable_clone</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *new_model, struct <a class="el" href="structoval__variable.html">oval_variable</a> *old_variable)</td></tr>
<tr class="memdesc:ga340cb9621c5af8d3e9ab6468cc1948e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone instance of <a class="el" href="structoval__variable.html">oval_variable</a> and add it to the specified <a class="el" href="structoval__definition__model.html">oval_definition_model</a>.  <a href="group__OVALDEF.html#ga340cb9621c5af8d3e9ab6468cc1948e0">More...</a><br/></td></tr>
<tr class="separator:ga340cb9621c5af8d3e9ab6468cc1948e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03c2d5ac6ac55948d5e2862422a04e2b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga03c2d5ac6ac55948d5e2862422a04e2b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga03c2d5ac6ac55948d5e2862422a04e2b">oval_variable_free</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga03c2d5ac6ac55948d5e2862422a04e2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free instance of <a class="el" href="structoval__variable.html">oval_variable</a>. <br/></td></tr>
<tr class="separator:ga03c2d5ac6ac55948d5e2862422a04e2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr>
<tr class="memitem:ga1936e1bd45e7fd22d11f7477bd5d8456"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga1936e1bd45e7fd22d11f7477bd5d8456">oval_variable_set_comment</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, char *comment)</td></tr>
<tr class="memdesc:ga1936e1bd45e7fd22d11f7477bd5d8456"><td class="mdescLeft">&#160;</td><td class="mdescRight">set attribute oval_variable-&gt;comment.  <a href="group__OVALDEF.html#ga1936e1bd45e7fd22d11f7477bd5d8456">More...</a><br/></td></tr>
<tr class="separator:ga1936e1bd45e7fd22d11f7477bd5d8456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c02ae430af80d08c398953cada67318"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga9c02ae430af80d08c398953cada67318">oval_variable_set_version</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, int version)</td></tr>
<tr class="memdesc:ga9c02ae430af80d08c398953cada67318"><td class="mdescLeft">&#160;</td><td class="mdescRight">set attribute oval_variable-&gt;version.  <a href="group__OVALDEF.html#ga9c02ae430af80d08c398953cada67318">More...</a><br/></td></tr>
<tr class="separator:ga9c02ae430af80d08c398953cada67318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59596758acd538be98ebd9b8775ab794"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga59596758acd538be98ebd9b8775ab794">oval_variable_set_deprecated</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, bool deprecated)</td></tr>
<tr class="memdesc:ga59596758acd538be98ebd9b8775ab794"><td class="mdescLeft">&#160;</td><td class="mdescRight">set attribute oval_variable-&gt;deprecated.  <a href="group__OVALDEF.html#ga59596758acd538be98ebd9b8775ab794">More...</a><br/></td></tr>
<tr class="separator:ga59596758acd538be98ebd9b8775ab794"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga838bbd211257461e7f354bf5f88a8a64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga838bbd211257461e7f354bf5f88a8a64">oval_variable_set_datatype</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, <a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a>)</td></tr>
<tr class="memdesc:ga838bbd211257461e7f354bf5f88a8a64"><td class="mdescLeft">&#160;</td><td class="mdescRight">set attribute oval_variable-&gt;datatype.  <a href="group__OVALDEF.html#ga838bbd211257461e7f354bf5f88a8a64">More...</a><br/></td></tr>
<tr class="separator:ga838bbd211257461e7f354bf5f88a8a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e2a5d7f39daee5edf747f568fa90e69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga4e2a5d7f39daee5edf747f568fa90e69">oval_variable_add_value</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, struct <a class="el" href="structoval__value.html">oval_value</a> *)</td></tr>
<tr class="memdesc:ga4e2a5d7f39daee5edf747f568fa90e69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append an instance of Oval_value to the attribute Oval_constant-&gt;values.  <a href="group__OVALDEF.html#ga4e2a5d7f39daee5edf747f568fa90e69">More...</a><br/></td></tr>
<tr class="separator:ga4e2a5d7f39daee5edf747f568fa90e69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga61cb4fd268434eb7f82400806be6e245"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga61cb4fd268434eb7f82400806be6e245">oval_variable_set_component</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *, struct <a class="el" href="structoval__component.html">oval_component</a> *component)</td></tr>
<tr class="memdesc:ga61cb4fd268434eb7f82400806be6e245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind an instance of Oval_component to the attribute Oval_local-&gt;component.  <a href="group__OVALDEF.html#ga61cb4fd268434eb7f82400806be6e245">More...</a><br/></td></tr>
<tr class="separator:ga61cb4fd268434eb7f82400806be6e245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Getters</div></td></tr>
<tr class="memitem:ga5af5f0a8f14194c6c95e8fed74c3ff2f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga5af5f0a8f14194c6c95e8fed74c3ff2f">oval_variable_get_id</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga5af5f0a8f14194c6c95e8fed74c3ff2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;id.  <a href="group__OVALDEF.html#ga5af5f0a8f14194c6c95e8fed74c3ff2f">More...</a><br/></td></tr>
<tr class="separator:ga5af5f0a8f14194c6c95e8fed74c3ff2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad31a4444a5d7198cec1e25006854d352"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gad31a4444a5d7198cec1e25006854d352">oval_variable_get_comment</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:gad31a4444a5d7198cec1e25006854d352"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;comment.  <a href="group__OVALDEF.html#gad31a4444a5d7198cec1e25006854d352">More...</a><br/></td></tr>
<tr class="separator:gad31a4444a5d7198cec1e25006854d352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d08e8be95f5c17f67c00e3b7214bd23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5d08e8be95f5c17f67c00e3b7214bd23"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga5d08e8be95f5c17f67c00e3b7214bd23">oval_variable_get_version</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga5d08e8be95f5c17f67c00e3b7214bd23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;version. <br/></td></tr>
<tr class="separator:ga5d08e8be95f5c17f67c00e3b7214bd23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga593a9f421ff46ada989895bf11c80788"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga593a9f421ff46ada989895bf11c80788"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga593a9f421ff46ada989895bf11c80788">oval_variable_get_deprecated</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga593a9f421ff46ada989895bf11c80788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;deprecated. <br/></td></tr>
<tr class="separator:ga593a9f421ff46ada989895bf11c80788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98d512ea3c2a9f50a2d1fc5337df30b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga98d512ea3c2a9f50a2d1fc5337df30b2"></a>
<a class="el" href="group__OVALDEF.html#ga508c483d127b48e6190a40b401962db6">oval_variable_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga98d512ea3c2a9f50a2d1fc5337df30b2">oval_variable_get_type</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga98d512ea3c2a9f50a2d1fc5337df30b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;type. <br/></td></tr>
<tr class="separator:ga98d512ea3c2a9f50a2d1fc5337df30b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3305986237d5bff16d84e9bfb92fea36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3305986237d5bff16d84e9bfb92fea36"></a>
<a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga3305986237d5bff16d84e9bfb92fea36">oval_variable_get_datatype</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:ga3305986237d5bff16d84e9bfb92fea36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute oval_variable-&gt;datatype. <br/></td></tr>
<tr class="separator:ga3305986237d5bff16d84e9bfb92fea36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb78c4dc3624c31dc87d4dfc4d12367e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__value__iterator.html">oval_value_iterator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gafb78c4dc3624c31dc87d4dfc4d12367e">oval_variable_get_values</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:gafb78c4dc3624c31dc87d4dfc4d12367e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute Oval_external/Oval_constant-&gt;values.  <a href="group__OVALDEF.html#gafb78c4dc3624c31dc87d4dfc4d12367e">More...</a><br/></td></tr>
<tr class="separator:gafb78c4dc3624c31dc87d4dfc4d12367e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa34166a9c0f382ee5c8343dd48d704f2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__component.html">oval_component</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaa34166a9c0f382ee5c8343dd48d704f2">oval_variable_get_component</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr class="memdesc:gaa34166a9c0f382ee5c8343dd48d704f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute Oval_local-&gt;component.  <a href="group__OVALDEF.html#gaa34166a9c0f382ee5c8343dd48d704f2">More...</a><br/></td></tr>
<tr class="separator:gaa34166a9c0f382ee5c8343dd48d704f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf0b9945f7d300e8f1f108bc9a59a0baf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0b9945f7d300e8f1f108bc9a59a0baf"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaf0b9945f7d300e8f1f108bc9a59a0baf">oval_component_type_get_text</a> (<a class="el" href="group__OVALDEF.html#gab6ed49a929aed7027c01b143ced8ba2d">oval_component_type_t</a> type)</td></tr>
<tr class="memdesc:gaf0b9945f7d300e8f1f108bc9a59a0baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns attribute Oval_component_type-&gt;text. <br/></td></tr>
<tr class="separator:gaf0b9945f7d300e8f1f108bc9a59a0baf"><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:aadb99044e9a4d0ecd9ca48f4a9532129"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadb99044e9a4d0ecd9ca48f4a9532129"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>VAR_BASE</b></td></tr>
<tr class="separator:aadb99044e9a4d0ecd9ca48f4a9532129"><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>An oval variable resolves an <a class="el" href="structoval__value.html">oval_value</a> stream which specifies constraints for <a class="el" href="structoval__object.html">oval_object</a><b>s</b> and <a class="el" href="structoval__state.html">oval_state</a><b>s</b>. </p>
<ul>
<li>if oval_variable_type == OVAL_VARIABLE_EXTERNAL<ul>
<li>The value stream is determined by oval_definition_model_bind_variable_model</li>
</ul>
</li>
<li>if oval_variable_type == OVAL_VARIABLE_CONSTANT<ul>
<li>The value stream is determined by a set of specified constants (see <a class="el" href="group__OVALDEF.html#ga4e2a5d7f39daee5edf747f568fa90e69">oval_variable_add_value</a>)</li>
</ul>
</li>
<li>if oval_variable_type == OVAL_VARIABLE_LOCAL<ul>
<li>The value stream is specified by either a single component or a complex function, meaning that a value can be as simple as a literal string or as complex as multiple registry keys concatenated together. Note that if an individual component is used and it returns multiple values, then there will be multiple values associated with the Oval_local. For example, if an object is specified as the local source and it references a file object that identifies a set of 5 files, then the local variable would represent these 5 values. </li>
</ul>
</li>
</ul>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="oval__variable_8c.html">oval_variable.c</a></li>
<li><a class="el" href="oval__definitions_8h_source.html">oval_definitions.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>