<!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 External Variable Binding</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><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> </div> <div class="contents"> <h1>OVAL External Variable Binding<br/> <small> [<a class="el" href="group__OVAL.html">OVAL</a>]</small> </h1> <p>Public interface to OVAL External Variable Binding. <a href="#_details">More...</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Data Structures</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__variable__model.html">oval_variable_model</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The OVAL variable model facilitates access to external variable value bindings used to to constrain the evaluation of OVAL objects. <a href="structoval__variable__model.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2>Files</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="oval__variables_8h.html">oval_variables.h</a></td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga275b0d836afc5e6b590744b74c918678">oval_variable_model::oval_variable_model_import</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *, struct <a class="el" href="structoscap__import__source.html">oscap_import_source</a> *, void *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Load the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a> from an XML stream. <a href="#ga275b0d836afc5e6b590744b74c918678"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabaafcd4d6b01dd453467648be6af9ef1"></a><!-- doxytag: member="OVALVAR::oval_variable_model_new" ref="gabaafcd4d6b01dd453467648be6af9ef1" args="(void)" --> struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#gabaafcd4d6b01dd453467648be6af9ef1">oval_variable_model::oval_variable_model_new</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new OVAL variable model. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae1c4184092de65edfe1424ad1759dd23"></a><!-- doxytag: member="OVALVAR::oval_variable_model_clone" ref="gae1c4184092de65edfe1424ad1759dd23" args="(struct oval_variable_model *)" --> struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#gae1c4184092de65edfe1424ad1759dd23">oval_variable_model::oval_variable_model_clone</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clone an OVAL variable model. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga365f33d97173121f2ad7ccfccf336843">oval_variable_model::oval_variable_model_free</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free memory allocated to a specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. <a href="#ga365f33d97173121f2ad7ccfccf336843"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#gafc39c319dc4ed43ab55b362bcdc19ce8">oval_variable_model::oval_variable_model_export</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *, struct <a class="el" href="structoscap__export__target.html">oscap_export_target</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Export the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a> to an XML stream. <a href="#gafc39c319dc4ed43ab55b362bcdc19ce8"></a><br/></td></tr> <tr><td colspan="2"><h2>Setters</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrp6e47466b75bb957a603aa54c079ac8bf"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga85e31b556710186bd3ee73af8005fc2b">oval_variable_model::oval_variable_model_lock</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *variable_model)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lock the variable_model instance. <a href="#ga85e31b556710186bd3ee73af8005fc2b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga462a5716ee28a72b8f053b188507551b">oval_variable_model::oval_variable_model_add</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *model, char *varid, const char *comment, <a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> datatype, char *value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the values bound to a specified external variable. <a href="#ga462a5716ee28a72b8f053b188507551b"></a><br/></td></tr> <tr><td colspan="2"><h2>Getters</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrpc9fd0bcb5385a65354c37f1bb504399d"></a> </p> <br/><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__OVALVAR.html#ga1dbc23e41fad2352ee9ac24578258bdf">oval_variable_model::oval_variable_model_get_variable_ids</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get all external variables managed by a specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. <a href="#ga1dbc23e41fad2352ee9ac24578258bdf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#gaf4a30ae55879ddf17627934f4fde1c9b">oval_variable_model::oval_variable_model_get_datatype</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *, char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a specified external variable datatype. <a href="#gaf4a30ae55879ddf17627934f4fde1c9b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga4b189de3fb06eb07c756d44e56ecd096">oval_variable_model::oval_variable_model_get_comment</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *, char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a specified external variable comment. <a href="#ga4b189de3fb06eb07c756d44e56ecd096"></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__OVALVAR.html#ga2e52fe832f3cf5c63d4d6890472e85c8">oval_variable_model::oval_variable_model_get_values</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *, char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the values bound to a specified external variable. <a href="#ga2e52fe832f3cf5c63d4d6890472e85c8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#ga021f29cdfde3e07d67953eef473f5565">oval_variable_model::oval_variable_model_is_locked</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *variable_model)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the variable_model instance is locked. <a href="#ga021f29cdfde3e07d67953eef473f5565"></a><br/></td></tr> <tr><td colspan="2"><h2>Evaluators</h2></td></tr> <tr><td colspan="2"><p><a class="anchor" id="amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf6bb2f236105616566abc218b91901c3"></a><!-- doxytag: member="OVALVAR::oval_variable_model_is_valid" ref="gaf6bb2f236105616566abc218b91901c3" args="(struct oval_variable_model *variable_model)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALVAR.html#gaf6bb2f236105616566abc218b91901c3">oval_variable_model::oval_variable_model_is_valid</a> (struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> *variable_model)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if the variable_model instance is valid. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Public interface to OVAL External Variable Binding. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga462a5716ee28a72b8f053b188507551b"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_add" ref="ga462a5716ee28a72b8f053b188507551b" args="(struct oval_variable_model *model, char *varid, const char *comment, oval_datatype_t datatype, char *value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void oval_variable_model_add </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname"> <em>model</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"> <em>varid</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>comment</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> </td> <td class="paramname"> <em>datatype</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"> <em>value</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the values bound to a specified external variable. </p> <p>If the varid does not resolve to a managed external variable, this method returns NULL. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>varid</em> </td><td>the identifier of the required <a class="el" href="structoval__variable.html" title="An oval variable resolves an oval_value stream which specifies constraints for oval_objects...">oval_variable</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="gafc39c319dc4ed43ab55b362bcdc19ce8"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_export" ref="gafc39c319dc4ed43ab55b362bcdc19ce8" args="(struct oval_variable_model *, struct oscap_export_target *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int oval_variable_model_export </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct <a class="el" href="structoscap__export__target.html">oscap_export_target</a> * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Export the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a> to an XML stream. </p> <p>The exported document element is a valid instance of <<a href="http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables">http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables</a>>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>export_target</em> </td><td>the <a class="el" href="structoscap__export__target.html">oscap_export_target</a> that resolves the output XML stream. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga365f33d97173121f2ad7ccfccf336843"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_free" ref="ga365f33d97173121f2ad7ccfccf336843" args="(struct oval_variable_model *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void oval_variable_model_free </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname"></td> <td> ) </td> <td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Free memory allocated to a specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a> </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga4b189de3fb06eb07c756d44e56ecd096"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_get_comment" ref="ga4b189de3fb06eb07c756d44e56ecd096" args="(struct oval_variable_model *, char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * oval_variable_model_get_comment </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get a specified external variable comment. </p> <p>If the varid does not resolve to a managed external variable, this method returns NULL. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>varid</em> </td><td>the identifier of the required <a class="el" href="structoval__variable.html" title="An oval variable resolves an oval_value stream which specifies constraints for oval_objects...">oval_variable</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="gaf4a30ae55879ddf17627934f4fde1c9b"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_get_datatype" ref="gaf4a30ae55879ddf17627934f4fde1c9b" args="(struct oval_variable_model *, char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__OVALDEF.html#gaf069fe2fb2a9ae3abe47cab55b89827e">oval_datatype_t</a> oval_variable_model_get_datatype </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get a specified external variable datatype. </p> <p>If the varid does not resolve to a managed external variable, this method returns 0. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>varid</em> </td><td>the identifier of the required <a class="el" href="structoval__variable.html" title="An oval variable resolves an oval_value stream which specifies constraints for oval_objects...">oval_variable</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga2e52fe832f3cf5c63d4d6890472e85c8"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_get_values" ref="ga2e52fe832f3cf5c63d4d6890472e85c8" args="(struct oval_variable_model *, char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structoval__string__iterator.html">oval_string_iterator</a> * oval_variable_model_get_values </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [read, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the values bound to a specified external variable. </p> <p>If the varid does not resolve to a managed external variable, this method returns NULL. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>varid</em> </td><td>the identifier of the required <a class="el" href="structoval__variable.html" title="An oval variable resolves an oval_value stream which specifies constraints for oval_objects...">oval_variable</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga1dbc23e41fad2352ee9ac24578258bdf"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_get_variable_ids" ref="ga1dbc23e41fad2352ee9ac24578258bdf" args="(struct oval_variable_model *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structoval__string__iterator.html">oval_string_iterator</a> * oval_variable_model_get_variable_ids </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname"></td> <td> ) </td> <td><code> [read, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get all external variables managed by a specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga275b0d836afc5e6b590744b74c918678"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_import" ref="ga275b0d836afc5e6b590744b74c918678" args="(struct oval_variable_model *, struct oscap_import_source *, void *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int oval_variable_model_import </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct <a class="el" href="structoscap__import__source.html">oscap_import_source</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Load the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a> from an XML stream. </p> <p>The stream document element must be a valid instance of <<a href="http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables">http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables</a>>. If the <a class="el" href="structoval__variable.html" title="An oval variable resolves an oval_value stream which specifies constraints for oval_objects...">oval_variable</a> model is not empty, the loaded content will be appended to the existing content. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>variable_model</em> </td><td>the specified <a class="el" href="structoval__variable__model.html" title="The OVAL variable model facilitates access to external variable value bindings used...">oval_variable_model</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>import_source</em> </td><td>the <a class="el" href="structoscap__import__source.html">oscap_import_source</a> that resolves the XML stream. </td></tr> <tr><td valign="top"></td><td valign="top"><em>user_param</em> </td><td>a user parameter that is passed the the error handler implementation. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga021f29cdfde3e07d67953eef473f5565"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_is_locked" ref="ga021f29cdfde3e07d67953eef473f5565" args="(struct oval_variable_model *variable_model)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool oval_variable_model_is_locked </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname"> <em>variable_model</em></td> <td> ) </td> <td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return <b>true</b> if the variable_model instance is locked. </p> <p>The state of a locked instance cannot be changed. </p> </div> </div> <a class="anchor" id="ga85e31b556710186bd3ee73af8005fc2b"></a><!-- doxytag: member="oval_variable_model::oval_variable_model_lock" ref="ga85e31b556710186bd3ee73af8005fc2b" args="(struct oval_variable_model *variable_model)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void oval_variable_model_lock </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structoval__variable__model.html">oval_variable_model</a> * </td> <td class="paramname"> <em>variable_model</em></td> <td> ) </td> <td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Lock the variable_model instance. </p> <p>The state of a locked instance cannot be changed. This operation has no effect if the model is already locked. </p> </div> </div> </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>