<!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_object 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_object Struct Reference<br/>
<small>
[<a class="el" href="group__OVALDEF.html">OVAL Definitions</a>]</small>
</h1><!-- doxytag: class="oval_object" -->
<p>An Oval_object instance describes a set of items to look for on an instrumented host platform.
<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__object.html">oval_object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga451cd01ae2705fc4593ee0ca5277fb19">oval_object_new</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *, char *id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct new intance of <a class="el" href="structoval__object.html">oval_object</a>. <a href="group__OVALDEF.html#ga451cd01ae2705fc4593ee0ca5277fb19"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f398a02efaaaa8962d68ad486c01a4e"></a><!-- doxytag: member="oval_object::oval_object_free" ref="ga7f398a02efaaaa8962d68ad486c01a4e" args="(struct oval_object *)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga7f398a02efaaaa8962d68ad486c01a4e">oval_object_free</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free instance of <a class="el" href="structoval__object.html">oval_object</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#gab8022028389fbea3d58ff68f259490ca">oval_object_set_subtype</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, <a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> subtype)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attributes <a class="el" href="structoval__object.html">oval_object</a>->subtype and <a class="el" href="structoval__object.html">oval_object</a>->family. <a href="group__OVALDEF.html#gab8022028389fbea3d58ff68f259490ca"></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#ga6acf65fe782b64885a38a7f9ef88f854">oval_object_add_note</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, char *note)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a copy of the note parameter to attribute <a class="el" href="structoval__object.html">oval_object</a>->notes. <a href="group__OVALDEF.html#ga6acf65fe782b64885a38a7f9ef88f854"></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#gaa8c0c1dd2ba2400ebcbc896169d5666b">oval_object_set_comment</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, char *comment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a copy of the comment parameter to attribute <a class="el" href="structoval__object.html">oval_object</a>->comment. <a href="group__OVALDEF.html#gaa8c0c1dd2ba2400ebcbc896169d5666b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaa4cd7b065405e47cab4794eaf149962"></a><!-- doxytag: member="oval_object::oval_object_set_deprecated" ref="gaaa4cd7b065405e47cab4794eaf149962" args="(struct oval_object *, bool deprecated)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaaa4cd7b065405e47cab4794eaf149962">oval_object_set_deprecated</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, bool deprecated)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attribute <a class="el" href="structoval__object.html">oval_object</a>->deprecated. <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#gaba746d196149d499e10bde052158a474">oval_object_set_version</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, int version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attribute <a class="el" href="structoval__object.html">oval_object</a>->version. <a href="group__OVALDEF.html#gaba746d196149d499e10bde052158a474"></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#gab62165673d2479dd5d27cb437e7120b8">oval_object_add_object_content</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, struct <a class="el" href="structoval__object__content.html">oval_object_content</a> *content)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append instance of <a class="el" href="structoval__object__content.html">oval_object_content</a> to attribute <a class="el" href="structoval__object.html">oval_object</a>->object_contents. <a href="group__OVALDEF.html#gab62165673d2479dd5d27cb437e7120b8"></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#ga01301c7353996e914cfddb52fb98a229">oval_object_add_behavior</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *, struct <a class="el" href="structoval__behavior.html">oval_behavior</a> *behavior)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append instance of <a class="el" href="structoval__behavior.html">oval_behavior</a> to attribute <a class="el" href="structoval__object.html">oval_object</a>->behaviors. <a href="group__OVALDEF.html#ga01301c7353996e914cfddb52fb98a229"></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="ga37ae5b026dae3ba19307bee4eabae755"></a><!-- doxytag: member="oval_object::oval_object_get_family" ref="ga37ae5b026dae3ba19307bee4eabae755" args="(struct oval_object *)" -->
<a class="el" href="group__OVAL.html#ga83b7e728a31f7ad0a0306ec1408f0a1a">oval_family_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga37ae5b026dae3ba19307bee4eabae755">oval_object_get_family</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->family. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga84349daf1af6150c3cacdf5e1de6cd1e">oval_object_get_name</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of an <a class="el" href="structoval__object.html">oval_object</a>. <a href="group__OVALDEF.html#ga84349daf1af6150c3cacdf5e1de6cd1e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0d345c0d277c3ddb7d3919eafbbbb1bd"></a><!-- doxytag: member="oval_object::oval_object_get_subtype" ref="ga0d345c0d277c3ddb7d3919eafbbbb1bd" args="(struct oval_object *)" -->
<a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga0d345c0d277c3ddb7d3919eafbbbb1bd">oval_object_get_subtype</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->subtype. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__string__iterator.html">oval_string_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga3c9bdd066ff355ac056618c3087e0fb1">oval_object_get_notes</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->notes. <a href="group__OVALDEF.html#ga3c9bdd066ff355ac056618c3087e0fb1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1f96b1099febf9cad3f8b8830be86b82"></a><!-- doxytag: member="oval_object::oval_object_get_comment" ref="ga1f96b1099febf9cad3f8b8830be86b82" args="(struct oval_object *)" -->
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga1f96b1099febf9cad3f8b8830be86b82">oval_object_get_comment</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->comment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7caf7a93229db23933ddb155db9314fa"></a><!-- doxytag: member="oval_object::oval_object_get_id" ref="ga7caf7a93229db23933ddb155db9314fa" args="(struct oval_object *)" -->
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga7caf7a93229db23933ddb155db9314fa">oval_object_get_id</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->id. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0e2c853a129e06691591d76f57ca7076"></a><!-- doxytag: member="oval_object::oval_object_get_deprecated" ref="ga0e2c853a129e06691591d76f57ca7076" args="(struct oval_object *)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga0e2c853a129e06691591d76f57ca7076">oval_object_get_deprecated</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->deprecated. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf4bc6662c4a38bf0667d44a2ef3d837b"></a><!-- doxytag: member="oval_object::oval_object_get_version" ref="gaf4bc6662c4a38bf0667d44a2ef3d837b" args="(struct oval_object *)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaf4bc6662c4a38bf0667d44a2ef3d837b">oval_object_get_version</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->version. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaea7af3fbe1776527e8eef6233aebe3b5"></a><!-- doxytag: member="oval_object::oval_object_get_object_contents" ref="gaea7af3fbe1776527e8eef6233aebe3b5" args="(struct oval_object *)" -->
struct <br class="typebreak"/>
<a class="el" href="structoval__object__content__iterator.html">oval_object_content_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaea7af3fbe1776527e8eef6233aebe3b5">oval_object_get_object_contents</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->contents. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab8bd2340de0758874def8c260fdd4054"></a><!-- doxytag: member="oval_object::oval_object_get_behaviors" ref="gab8bd2340de0758874def8c260fdd4054" args="(struct oval_object *)" -->
struct <a class="el" href="structoval__behavior__iterator.html">oval_behavior_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gab8bd2340de0758874def8c260fdd4054">oval_object_get_behaviors</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute <a class="el" href="structoval__object.html">oval_object</a>->behaviors. <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#ga81cb3eac4127c92051d5b33ad9e55928">oval_object_is_locked</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <b>true</b> if the object instance is locked. <a href="group__OVALDEF.html#ga81cb3eac4127c92051d5b33ad9e55928"></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="ga2c81c85dcbe63fea465e3ad5381bbd93"></a><!-- doxytag: member="oval_object::oval_object_is_valid" ref="ga2c81c85dcbe63fea465e3ad5381bbd93" args="(struct oval_object *object)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga2c81c85dcbe63fea465e3ad5381bbd93">oval_object_is_valid</a> (struct <a class="el" href="structoval__object.html">oval_object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the object instance is valid. <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="a68ed77ea493d8ef3e2cdb53af5d33764"></a><!-- doxytag: member="oval_object::model" ref="a68ed77ea493d8ef3e2cdb53af5d33764" 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="ac268753325b86bee65e19abadf1254c5"></a><!-- doxytag: member="oval_object::subtype" ref="ac268753325b86bee65e19abadf1254c5" args="" -->
<a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> </td><td class="memItemRight" valign="bottom"><b>subtype</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a221176fb024becd2c75b176f93a4b7f2"></a><!-- doxytag: member="oval_object::notes" ref="a221176fb024becd2c75b176f93a4b7f2" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>notes</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d9317866b0dfb692feb858938342b2d"></a><!-- doxytag: member="oval_object::comment" ref="a5d9317866b0dfb692feb858938342b2d" 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="a0b64a9bf5faefe569d89bde4ede4515e"></a><!-- doxytag: member="oval_object::id" ref="a0b64a9bf5faefe569d89bde4ede4515e" 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="a405d77f7a9b28c5bf3d992e6d5da0a81"></a><!-- doxytag: member="oval_object::deprecated" ref="a405d77f7a9b28c5bf3d992e6d5da0a81" 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="af1b3f655bb3dd0e2271ede9a1c031a79"></a><!-- doxytag: member="oval_object::version" ref="af1b3f655bb3dd0e2271ede9a1c031a79" 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="a9906ce242d2a053e6f3da52af6804b98"></a><!-- doxytag: member="oval_object::object_content" ref="a9906ce242d2a053e6f3da52af6804b98" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>object_content</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55ade63deb9999f79221801283ad5332"></a><!-- doxytag: member="oval_object::behaviors" ref="a55ade63deb9999f79221801283ad5332" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>behaviors</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An Oval_object instance describes a set of items to look for on an instrumented host platform. </p>
<p>A simple object will usually result in a single file, process, etc being identified. But through the use pattern matches, sets, and variables, multiple matching objects can be identified. Therefore an OVAL Object can identify a set of many individual items on a system. This set of items defined by the OVAL Object can then be used by an OVAL Test and compared against an OVAL State. </p>
<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__object_8c.html">oval_object.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>
