<!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_state 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_state Struct Reference<div class="ingroups"><a class="el" href="group__OVALDEF.html">OVAL Definitions</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="oval_state" --> <p>An Oval_state instance is a collection of one or more characteristics pertaining to a specific object type. <a href="structoval__state.html#details">More...</a></p> <p><code>#include <<a class="el" href="oval__definitions_8h_source.html">oval_definitions.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">struct <a class="el" href="structoval__state.html">oval_state</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga232ee583317c4e71772f75ff13d0f74c">oval_state_new</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *, const char *id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct new intance of <a class="el" href="structoval__state.html">oval_state</a>. <a href="group__OVALDEF.html#ga232ee583317c4e71772f75ff13d0f74c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__state.html">oval_state</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaa7951fab775252622de5d3d1b2a8a0f0">oval_state_clone</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *new_model, struct <a class="el" href="structoval__state.html">oval_state</a> *old_state)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clone instance of <a class="el" href="structoval__state.html">oval_state</a> and add it to the specified <a class="el" href="structoval__definition__model.html">oval_definition_model</a>. <a href="group__OVALDEF.html#gaa7951fab775252622de5d3d1b2a8a0f0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae570dacf481fc02cfdf3420a53b91b29"></a><!-- doxytag: member="oval_state::oval_state_free" ref="gae570dacf481fc02cfdf3420a53b91b29" args="(struct oval_state *)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gae570dacf481fc02cfdf3420a53b91b29">oval_state_free</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free instance of <a class="el" href="structoval__state.html">oval_state</a>. <br/></td></tr> <tr><td colspan="2"><div class="groupHeader">Setters</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#ga312270d697ba5aec73b0765a0b572d57">oval_state_set_subtype</a> (struct <a class="el" href="structoval__state.html">oval_state</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 oval_state->subtype and oval_state->family. <a href="group__OVALDEF.html#ga312270d697ba5aec73b0765a0b572d57"></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#ga9371475d9d286345d880e24b7d6297ff">oval_state_add_note</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, char *note)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a copy of the note parameter to attribute oval_state->notes. <a href="group__OVALDEF.html#ga9371475d9d286345d880e24b7d6297ff"></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#ga81844120fd22784391967ae54f4815cd">oval_state_set_comment</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, char *comment)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a copy of the comment parameter to attribute oval_state->comment. <a href="group__OVALDEF.html#ga81844120fd22784391967ae54f4815cd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga81d256f6e88910ad6bf1c70ee3a73c1d"></a><!-- doxytag: member="oval_state::oval_state_set_deprecated" ref="ga81d256f6e88910ad6bf1c70ee3a73c1d" args="(struct oval_state *, bool deprecated)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga81d256f6e88910ad6bf1c70ee3a73c1d">oval_state_set_deprecated</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, bool deprecated)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attribute oval_state->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#ga4de8c320f537f7636691ea7bc1898ed2">oval_state_set_version</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, int version)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attribute oval_state->version. <a href="group__OVALDEF.html#ga4de8c320f537f7636691ea7bc1898ed2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b4a079d27e320bd135a8a3314a9b141"></a><!-- doxytag: member="oval_state::oval_state_set_operator" ref="ga8b4a079d27e320bd135a8a3314a9b141" args="(struct oval_state *, oval_operator_t)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga8b4a079d27e320bd135a8a3314a9b141">oval_state_set_operator</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, <a class="el" href="group__OVALDEF.html#gad5debd6ffe0c38c6de9108e86ee237e6">oval_operator_t</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets attribute oval_state->operator. <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#ga4d65d2f430c82dd92d5822728aa86e1f">oval_state_add_content</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *, struct <a class="el" href="structoval__state__content.html">oval_state_content</a> *content)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Append instance of <a class="el" href="structoval__state__content.html">oval_state_content</a> to attribute oval_state->state_contents. <a href="group__OVALDEF.html#ga4d65d2f430c82dd92d5822728aa86e1f"></a><br/></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="ga8693c2d07171ce7fa37cd41b253a9348"></a><!-- doxytag: member="oval_state::oval_state_get_family" ref="ga8693c2d07171ce7fa37cd41b253a9348" args="(struct oval_state *)" --> <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#ga8693c2d07171ce7fa37cd41b253a9348">oval_state_get_family</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->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#ga685f5e181ecde5479106f1b72030013d">oval_state_get_name</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of an <a class="el" href="structoval__state.html">oval_state</a>. <a href="group__OVALDEF.html#ga685f5e181ecde5479106f1b72030013d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadb8affdb7564eff0b6b5ef3ee3f73512"></a><!-- doxytag: member="oval_state::oval_state_get_subtype" ref="gadb8affdb7564eff0b6b5ef3ee3f73512" args="(struct oval_state *)" --> <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#gadb8affdb7564eff0b6b5ef3ee3f73512">oval_state_get_subtype</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->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#ga2a3675893b4241ffdee4447f7d1aa3f2">oval_state_get_notes</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->notes. <a href="group__OVALDEF.html#ga2a3675893b4241ffdee4447f7d1aa3f2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga8edde47e7d781d442cbc8e5fdf37e9b7">oval_state_get_comment</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->comment. <a href="group__OVALDEF.html#ga8edde47e7d781d442cbc8e5fdf37e9b7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga72a7ee9bae3338e20ff89aa51b0d95d0">oval_state_get_id</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->id. <a href="group__OVALDEF.html#ga72a7ee9bae3338e20ff89aa51b0d95d0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga272d726ebb434d85c0c9b084e88e3b17"></a><!-- doxytag: member="oval_state::oval_state_get_deprecated" ref="ga272d726ebb434d85c0c9b084e88e3b17" args="(struct oval_state *)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga272d726ebb434d85c0c9b084e88e3b17">oval_state_get_deprecated</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->deprecated. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga989cf2ff0a094e5d1b7ee107cc0bfdc9"></a><!-- doxytag: member="oval_state::oval_state_get_version" ref="ga989cf2ff0a094e5d1b7ee107cc0bfdc9" args="(struct oval_state *)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga989cf2ff0a094e5d1b7ee107cc0bfdc9">oval_state_get_version</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->version. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaab999ca597b76309cc58214d2023a678"></a><!-- doxytag: member="oval_state::oval_state_get_operator" ref="gaab999ca597b76309cc58214d2023a678" args="(struct oval_state *)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaab999ca597b76309cc58214d2023a678">oval_state_get_operator</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->operator. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct <br class="typebreak"/> <a class="el" href="structoval__state__content__iterator.html">oval_state_content_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga6d38e6821748f4daf018ad5d02bbbb7d">oval_state_get_contents</a> (struct <a class="el" href="structoval__state.html">oval_state</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns attribute oval_state->contents. <a href="group__OVALDEF.html#ga6d38e6821748f4daf018ad5d02bbbb7d"></a><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="a124c6f0bcfbe7b14194d90223192ce78"></a><!-- doxytag: member="oval_state::model" ref="a124c6f0bcfbe7b14194d90223192ce78" 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="a9e08fa3032accfc99644d8c881dd0658"></a><!-- doxytag: member="oval_state::subtype" ref="a9e08fa3032accfc99644d8c881dd0658" 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="a63389d0532ee823a4791e80ceb5efefb"></a><!-- doxytag: member="oval_state::comment" ref="a63389d0532ee823a4791e80ceb5efefb" 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="ac38771338ecd5ed1d040684445748bfe"></a><!-- doxytag: member="oval_state::id" ref="ac38771338ecd5ed1d040684445748bfe" 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="adc7bdb003872449c0e73c2d662e858dd"></a><!-- doxytag: member="oval_state::deprecated" ref="adc7bdb003872449c0e73c2d662e858dd" 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="ad9fa3609d73637d4bf900c119c639da8"></a><!-- doxytag: member="oval_state::version" ref="ad9fa3609d73637d4bf900c119c639da8" 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="a024fccf2c13fba5acdaef5d9f0361c9c"></a><!-- doxytag: member="oval_state::operator" ref="a024fccf2c13fba5acdaef5d9f0361c9c" args="" --> <a class="el" href="group__OVALDEF.html#gad5debd6ffe0c38c6de9108e86ee237e6">oval_operator_t</a> </td><td class="memItemRight" valign="bottom"><b>operator</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a838c353b5a894a7866a2c44f63052992"></a><!-- doxytag: member="oval_state::notes" ref="a838c353b5a894a7866a2c44f63052992" 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="a4a57e76e0769e6ec010d2ad60d8e1afe"></a><!-- doxytag: member="oval_state::contents" ref="a4a57e76e0769e6ec010d2ad60d8e1afe" args="" --> struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>contents</b></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>An Oval_state instance is a collection of one or more characteristics pertaining to a specific object type. </p> <p>The Oval_state is used by an during the evaluation of an Oval_test to determine if a set of items queried by an Oval_object on a instrumented host meet certain characteristics. </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__state_8c.html">oval_state.c</a></li> <li>/home/pvrabec/project/openscap/openscap-0.7.4/src/OVAL/public/<a class="el" href="oval__definitions_8h_source.html">oval_definitions.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>