<!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_variable 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_variable Struct Reference<br/>
<small>
[<a class="el" href="group__OVALDEF.html">OVAL Definitions</a>]</small>
</h1><!-- doxytag: class="oval_variable" -->
<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="#_details">More...</a></p>
<p><code>#include <<a class="el" href="oval__definitions_8h_source.html">oval_definitions.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">struct <a class="el" href="structoval__variable.html">oval_variable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga3b9d7433d8c7b7e99265a0421cc21aea">oval_variable_new</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model, char *id, <a class="el" href="group__OVALDEF.html#ga508c483d127b48e6190a40b401962db6">oval_variable_type_t</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct new instance of <a class="el" href="structoval__variable.html">oval_variable</a>. <a href="group__OVALDEF.html#ga3b9d7433d8c7b7e99265a0421cc21aea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga03c2d5ac6ac55948d5e2862422a04e2b"></a><!-- doxytag: member="oval_variable::oval_variable_free" ref="ga03c2d5ac6ac55948d5e2862422a04e2b" args="(struct oval_variable *)" -->
void </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><td class="mdescLeft"> </td><td class="mdescRight">Free instance of <a class="el" href="structoval__variable.html">oval_variable</a>. <br/></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">void </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><td class="mdescLeft"> </td><td class="mdescRight">set attribute <a class="el" href="structoval__variable.html">oval_variable</a>->comment. <a href="group__OVALDEF.html#ga1936e1bd45e7fd22d11f7477bd5d8456"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">set attribute <a class="el" href="structoval__variable.html">oval_variable</a>->version. <a href="group__OVALDEF.html#ga9c02ae430af80d08c398953cada67318"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">set attribute <a class="el" href="structoval__variable.html">oval_variable</a>->deprecated. <a href="group__OVALDEF.html#ga59596758acd538be98ebd9b8775ab794"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">set attribute <a class="el" href="structoval__variable.html">oval_variable</a>->datatype. <a href="group__OVALDEF.html#ga838bbd211257461e7f354bf5f88a8a64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">Append an instance of Oval_value to the attribute Oval_constant->values. <a href="group__OVALDEF.html#ga4e2a5d7f39daee5edf747f568fa90e69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">Bind an instance of Oval_component to the attribute Oval_local->component. <a href="group__OVALDEF.html#ga61cb4fd268434eb7f82400806be6e245"></a><br/></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="ga5af5f0a8f14194c6c95e8fed74c3ff2f"></a><!-- doxytag: member="oval_variable::oval_variable_get_id" ref="ga5af5f0a8f14194c6c95e8fed74c3ff2f" args="(struct oval_variable *)" -->
char * </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->id. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad31a4444a5d7198cec1e25006854d352"></a><!-- doxytag: member="oval_variable::oval_variable_get_comment" ref="gad31a4444a5d7198cec1e25006854d352" args="(struct oval_variable *)" -->
char * </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->comment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5d08e8be95f5c17f67c00e3b7214bd23"></a><!-- doxytag: member="oval_variable::oval_variable_get_version" ref="ga5d08e8be95f5c17f67c00e3b7214bd23" args="(struct oval_variable *)" -->
int </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->version. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga593a9f421ff46ada989895bf11c80788"></a><!-- doxytag: member="oval_variable::oval_variable_get_deprecated" ref="ga593a9f421ff46ada989895bf11c80788" args="(struct oval_variable *)" -->
bool </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->deprecated. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga98d512ea3c2a9f50a2d1fc5337df30b2"></a><!-- doxytag: member="oval_variable::oval_variable_get_type" ref="ga98d512ea3c2a9f50a2d1fc5337df30b2" args="(struct oval_variable *)" -->
<a class="el" href="group__OVALDEF.html#ga508c483d127b48e6190a40b401962db6">oval_variable_type_t</a> </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3305986237d5bff16d84e9bfb92fea36"></a><!-- doxytag: member="oval_variable::oval_variable_get_datatype" ref="ga3305986237d5bff16d84e9bfb92fea36" args="(struct oval_variable *)" -->
<a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__variable.html">oval_variable</a>->datatype. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__value__iterator.html">oval_value_iterator</a> * </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute Oval_external/Oval_constant->values. <a href="group__OVALDEF.html#gafb78c4dc3624c31dc87d4dfc4d12367e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__component.html">oval_component</a> * </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute Oval_local->component. <a href="group__OVALDEF.html#gaa34166a9c0f382ee5c8343dd48d704f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0b9945f7d300e8f1f108bc9a59a0baf"></a><!-- doxytag: member="oval_variable::oval_component_type_get_text" ref="gaf0b9945f7d300e8f1f108bc9a59a0baf" args="(oval_component_type_t type)" -->
const char * </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><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute Oval_component_type->text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaa99c5967d8423ffab7d848bcdf1e850a">oval_variable_is_locked</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *variable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <b>true</b> if the variable instance is locked. <a href="group__OVALDEF.html#gaa99c5967d8423ffab7d848bcdf1e850a"></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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gadeab307b8a0dbe9b211d71944dda11f1">oval_variable_is_valid</a> (struct <a class="el" href="structoval__variable.html">oval_variable</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <b>true</b> if <a class="el" href="structoval__variable.html">oval_variable</a> is valid. <a href="group__OVALDEF.html#gadeab307b8a0dbe9b211d71944dda11f1"></a><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="a5647d40c68aacd5553c55e40f2ae3c7e"></a><!-- doxytag: member="oval_variable::model" ref="a5647d40c68aacd5553c55e40f2ae3c7e" args="" -->
struct <a class="el" href="structoval__definition__model.html">oval_definition_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="ab17e927a445ac3796fe9daba09760693"></a><!-- doxytag: member="oval_variable::id" ref="ab17e927a445ac3796fe9daba09760693" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed3966f163fc5c24d0ddc0dc88e35c07"></a><!-- doxytag: member="oval_variable::comment" ref="aed3966f163fc5c24d0ddc0dc88e35c07" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>comment</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63bd4ef459339744a07b8dd8e6da517c"></a><!-- doxytag: member="oval_variable::version" ref="a63bd4ef459339744a07b8dd8e6da517c" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>version</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0aea2f7eb151cb060be83f1657ef0b9"></a><!-- doxytag: member="oval_variable::deprecated" ref="ac0aea2f7eb151cb060be83f1657ef0b9" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>deprecated</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96e42cbd4165d6c2dcdf20d60053c029"></a><!-- doxytag: member="oval_variable::type" ref="a96e42cbd4165d6c2dcdf20d60053c029" args="" -->
<a class="el" href="group__OVALDEF.html#ga508c483d127b48e6190a40b401962db6">oval_variable_type_t</a> </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27e806d29d596ba9ed6fa819579670fc"></a><!-- doxytag: member="oval_variable::datatype" ref="a27e806d29d596ba9ed6fa819579670fc" args="" -->
<a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> </td><td class="memItemRight" valign="bottom"><b>datatype</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1244a7a9b39a224d1376c00a59af554"></a><!-- doxytag: member="oval_variable::flag" ref="ad1244a7a9b39a224d1376c00a59af554" 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="a07f0a4f57ecdcfa0c3ee7311a89860da"></a><!-- doxytag: member="oval_variable::values" ref="a07f0a4f57ecdcfa0c3ee7311a89860da" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>values</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/pvrabec/openscap/openscap-0.5.7/src/OVAL/<a class="el" href="oval__variable_8c.html">oval_variable.c</a></li>
<li>/home/pvrabec/openscap/openscap-0.5.7/src/OVAL/public/<a class="el" href="oval__definitions_8h_source.html">oval_definitions.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 26 Feb 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>
