<!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.7.4 -->
<div id="top">
<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>
<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 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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<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>
<div class="contents">
<!-- doxytag: class="oval_syschar" -->
<p>Characteristics bound to an Oval_object.
<a href="structoval__syschar.html#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 class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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 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="gac64c5e2cd5287d96a1989011afeba81d"></a><!-- doxytag: member="oval_syschar::oval_syschar_add_sysitem" ref="gac64c5e2cd5287d96a1989011afeba81d" args="(struct oval_syschar *, struct oval_sysitem *)" -->
void </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><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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0aded11a96cac70a4a92f2affd34196a"></a><!-- doxytag: member="oval_syschar::oval_syschar_add_new_message" ref="ga0aded11a96cac70a4a92f2affd34196a" args="(struct oval_syschar *syschar, char *text, oval_message_level_t level)" -->
void </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><td colspan="2"><div class="groupHeader">Getters</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="ga339bf10ccdf346d4c530b6dce3c35749"></a><!-- doxytag: member="oval_syschar::oval_syschar_get_sysitem" ref="ga339bf10ccdf346d4c530b6dce3c35749" args="(struct oval_syschar *)" -->
struct <a class="el" href="structoval__sysitem__iterator.html">oval_sysitem_iterator</a> * </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><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristic data. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
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="a8d6eddbb386fdc3cef34d82bfa23a41d"></a><!-- doxytag: member="oval_syschar::sysitem" ref="a8d6eddbb386fdc3cef34d82bfa23a41d" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>sysitem</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>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>/home/pvrabec/project/openscap/openscap-0.7.4/src/OVAL/<a class="el" href="oval__syschar_8c.html">oval_syschar.c</a></li>
<li>/home/pvrabec/project/openscap/openscap-0.7.4/src/OVAL/public/<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
