<!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_affected 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_affected Struct Reference<br/>
<small>
[<a class="el" href="group__OVALDEF.html">OVAL Definitions</a>]</small>
</h1><!-- doxytag: class="oval_affected" -->
<p>Each OVAL Definition specifies certain type of affected system(s).
<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"><a class="anchor" id="gac852abd08a4a3eb1fe6620ed15125d08"></a><!-- doxytag: member="oval_affected::oval_affected_new" ref="gac852abd08a4a3eb1fe6620ed15125d08" args="(struct oval_definition_model *)" -->
struct <a class="el" href="structoval__affected.html">oval_affected</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gac852abd08a4a3eb1fe6620ed15125d08">oval_affected_new</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct instance of <a class="el" href="structoval__affected.html">oval_affected</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5fe063593c56be6a68971ca4370b3788"></a><!-- doxytag: member="oval_affected::oval_affected_clone" ref="ga5fe063593c56be6a68971ca4370b3788" args="(struct oval_definition_model *new_model, struct oval_affected *old_affected)" -->
struct <a class="el" href="structoval__affected.html">oval_affected</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga5fe063593c56be6a68971ca4370b3788">oval_affected_clone</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *new_model, struct <a class="el" href="structoval__affected.html">oval_affected</a> *old_affected)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone instance of <a class="el" href="structoval__affected.html">oval_affected</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4287b6237b907d038369121515b3b36c"></a><!-- doxytag: member="oval_affected::oval_affected_free" ref="ga4287b6237b907d038369121515b3b36c" args="(struct oval_affected *)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga4287b6237b907d038369121515b3b36c">oval_affected_free</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release instance of <a class="el" href="structoval__affected.html">oval_affected</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"><a class="anchor" id="ga7a089f0bf5c07c14e6b332c4ba1e36b1"></a><!-- doxytag: member="oval_affected::oval_affected_set_family" ref="ga7a089f0bf5c07c14e6b332c4ba1e36b1" args="(struct oval_affected *, oval_affected_family_t family)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga7a089f0bf5c07c14e6b332c4ba1e36b1">oval_affected_set_family</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *, <a class="el" href="group__OVALDEF.html#ga80d323a50a1976c7ecc926976b12af20">oval_affected_family_t</a> family)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <a class="el" href="structoval__affected.html">oval_affected</a> family. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4c9f46f654ca1b45bd26ed5e85d46db9"></a><!-- doxytag: member="oval_affected::oval_affected_add_platform" ref="ga4c9f46f654ca1b45bd26ed5e85d46db9" args="(struct oval_affected *, char *platform_name)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga4c9f46f654ca1b45bd26ed5e85d46db9">oval_affected_add_platform</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *, char *platform_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append name to <a class="el" href="structoval__affected.html">oval_affected</a> platform names. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabc040498092740e14143a60da141d484"></a><!-- doxytag: member="oval_affected::oval_affected_add_product" ref="gabc040498092740e14143a60da141d484" args="(struct oval_affected *, char *product_name)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gabc040498092740e14143a60da141d484">oval_affected_add_product</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *, char *product_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append name to <a class="el" href="structoval__affected.html">oval_affected</a> product names. <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="el" href="group__OVALDEF.html#ga80d323a50a1976c7ecc926976b12af20">oval_affected_family_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#gaece6f8a5be53f40d8f27cf6c6e7ca3e8">oval_affected_get_family</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get member value <a class="el" href="structoval__affected.html">oval_affected</a> family. <a href="group__OVALDEF.html#gaece6f8a5be53f40d8f27cf6c6e7ca3e8"></a><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#gaa8d60e9521d33a23a45a226e2e1fd9e9">oval_affected_get_platforms</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get member values <a class="el" href="structoval__affected.html">oval_affected</a> platform_names. <a href="group__OVALDEF.html#gaa8d60e9521d33a23a45a226e2e1fd9e9"></a><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#gae6b67c6277ae893cedfc550c372146ae">oval_affected_get_products</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get member values <a class="el" href="structoval__affected.html">oval_affected</a> product_names. <a href="group__OVALDEF.html#gae6b67c6277ae893cedfc550c372146ae"></a><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#ga1279471745d0ece4b751880858a2a130">oval_affected_is_locked</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the instance of <a class="el" href="structoval__affected.html" title="Each OVAL Definition specifies certain type of affected system(s).">oval_affected</a> is locked. <a href="group__OVALDEF.html#ga1279471745d0ece4b751880858a2a130"></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="ga6b2be0bf1361e5c137d7f1e1725fdf4e"></a><!-- doxytag: member="oval_affected::oval_affected_is_valid" ref="ga6b2be0bf1361e5c137d7f1e1725fdf4e" args="(struct oval_affected *)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALDEF.html#ga6b2be0bf1361e5c137d7f1e1725fdf4e">oval_affected_is_valid</a> (struct <a class="el" href="structoval__affected.html">oval_affected</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <b>true</b>. <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="a08e4f18f76d3f752d41eb98a27868311"></a><!-- doxytag: member="oval_affected::model" ref="a08e4f18f76d3f752d41eb98a27868311" 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="aec0ccdd94f7fd421ca644931a0053f11"></a><!-- doxytag: member="oval_affected::family" ref="aec0ccdd94f7fd421ca644931a0053f11" args="" -->
<a class="el" href="group__OVALDEF.html#ga80d323a50a1976c7ecc926976b12af20">oval_affected_family_t</a> </td><td class="memItemRight" valign="bottom"><b>family</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af130dd375eefe6d0ea492a28905668cf"></a><!-- doxytag: member="oval_affected::platforms" ref="af130dd375eefe6d0ea492a28905668cf" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>platforms</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8e42d37136829feb0b01f080a582e8e"></a><!-- doxytag: member="oval_affected::products" ref="ad8e42d37136829feb0b01f080a582e8e" args="" -->
struct <a class="el" href="structoval__collection.html">oval_collection</a> * </td><td class="memItemRight" valign="bottom"><b>products</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Each OVAL Definition specifies certain type of affected system(s). </p>
<p>The family, platform(s), and product(s) of this target are described by the Oval_affected component whose main purpose is to provide hints for tools using OVAL Definitions. For instance, to help a reporting tool only use Windows definitions, or to preselect only Red Hat definitions to be evaluated. Note, the inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section.</p>
<p>The AffectedType complex type details the specific system, application, subsystem, library, etc. for which a definition has been written. If a definition is not tied to a specific product, then this element should not be included. The absence of the platform or product element can be thought of as definition applying to all platforms or products. The inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section. To increase the utility of this element, care should be taken when assigning and using strings for product names. The schema places no restrictions on the values that can be assigned, potentially leading to many different representations of the same value. For example 'Internet Explorer' and 'IE'. The current convention is to fully spell out all terms, and avoid the use of abbreviations at all costs. </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__affected_8c.html">oval_affected.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>
