OVAL External Variable Binding
[OVAL]

Public interface to OVAL External Variable Binding. More...

Data Structures

struct  oval_variable_model
 The OVAL variable model facilitates access to external variable value bindings used to to constrain the evaluation of OVAL objects. More...

Files

file  oval_variables.h

Functions

int oval_variable_model::oval_variable_model_import (struct oval_variable_model *, struct oscap_import_source *, void *)
 Load the specified oval_variable_model from an XML stream.
struct oval_variable_modeloval_variable_model::oval_variable_model_new (void)
 Create a new OVAL variable model.
struct oval_variable_modeloval_variable_model::oval_variable_model_clone (struct oval_variable_model *)
 Clone an OVAL variable model.
void oval_variable_model::oval_variable_model_free (struct oval_variable_model *)
 Free memory allocated to a specified oval_variable_model.
int oval_variable_model::oval_variable_model_export (struct oval_variable_model *, struct oscap_export_target *)
 Export the specified oval_variable_model to an XML stream.

Setters



void oval_variable_model::oval_variable_model_lock (struct oval_variable_model *variable_model)
 Lock the variable_model instance.
void oval_variable_model::oval_variable_model_add (struct oval_variable_model *model, char *varid, const char *comment, oval_datatype_t datatype, char *value)
 Get the values bound to a specified external variable.

Getters



struct oval_string_iteratoroval_variable_model::oval_variable_model_get_variable_ids (struct oval_variable_model *)
 Get all external variables managed by a specified oval_variable_model.
oval_datatype_t oval_variable_model::oval_variable_model_get_datatype (struct oval_variable_model *, char *)
 Get a specified external variable datatype.
const char * oval_variable_model::oval_variable_model_get_comment (struct oval_variable_model *, char *)
 Get a specified external variable comment.
struct oval_string_iteratoroval_variable_model::oval_variable_model_get_values (struct oval_variable_model *, char *)
 Get the values bound to a specified external variable.
bool oval_variable_model::oval_variable_model_is_locked (struct oval_variable_model *variable_model)
 Return true if the variable_model instance is locked.

Evaluators



bool oval_variable_model::oval_variable_model_is_valid (struct oval_variable_model *variable_model)
 Return true if the variable_model instance is valid.

Detailed Description

Public interface to OVAL External Variable Binding.


Function Documentation

void oval_variable_model_add ( struct oval_variable_model model,
char *  varid,
const char *  comment,
oval_datatype_t  datatype,
char *  value 
) [inherited]

Get the values bound to a specified external variable.

If the varid does not resolve to a managed external variable, this method returns NULL.

Parameters:
variable_model the specified oval_variable_model.
varid the identifier of the required oval_variable.
struct oval_variable_model * oval_variable_model_clone ( struct oval_variable_model  )  [read, inherited]

Clone an OVAL variable model.

Returns:
A copy of the specified oval_variable_model.
int oval_variable_model_export ( struct oval_variable_model ,
struct oscap_export_target  
) [inherited]

Export the specified oval_variable_model to an XML stream.

The exported document element is a valid instance of <http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables>.

Parameters:
variable_model the specified oval_variable_model.
export_target the oscap_export_target that resolves the output XML stream.
void oval_variable_model_free ( struct oval_variable_model  )  [inherited]

Free memory allocated to a specified oval_variable_model.

Parameters:
variable_model the specified oval_variable_model
const char * oval_variable_model_get_comment ( struct oval_variable_model ,
char *   
) [inherited]

Get a specified external variable comment.

If the varid does not resolve to a managed external variable, this method returns NULL.

Parameters:
variable_model the specified oval_variable_model.
varid the identifier of the required oval_variable.
oval_datatype_t oval_variable_model_get_datatype ( struct oval_variable_model ,
char *   
) [inherited]

Get a specified external variable datatype.

If the varid does not resolve to a managed external variable, this method returns 0.

Parameters:
variable_model the specified oval_variable_model.
varid the identifier of the required oval_variable.
struct oval_string_iterator * oval_variable_model_get_values ( struct oval_variable_model ,
char *   
) [read, inherited]

Get the values bound to a specified external variable.

If the varid does not resolve to a managed external variable, this method returns NULL.

Parameters:
variable_model the specified oval_variable_model.
varid the identifier of the required oval_variable.
struct oval_string_iterator * oval_variable_model_get_variable_ids ( struct oval_variable_model  )  [read, inherited]

Get all external variables managed by a specified oval_variable_model.

Parameters:
variable_model the specified oval_variable_model.
int oval_variable_model_import ( struct oval_variable_model ,
struct oscap_import_source ,
void *   
) [inherited]

Load the specified oval_variable_model from an XML stream.

The stream document element must be a valid instance of <http://oval.mitre.org/XMLSchema/oval-variables-5:oval_variables>. If the oval_variable model is not empty, the loaded content will be appended to the existing content.

Parameters:
variable_model the specified oval_variable_model.
import_source the oscap_import_source that resolves the XML stream.
user_param a user parameter that is passed the the error handler implementation.
bool oval_variable_model_is_locked ( struct oval_variable_model variable_model  )  [inherited]

Return true if the variable_model instance is locked.

The state of a locked instance cannot be changed.

void oval_variable_model_lock ( struct oval_variable_model variable_model  )  [inherited]

Lock the variable_model instance.

The state of a locked instance cannot be changed. This operation has no effect if the model is already locked.


Generated on 24 Mar 2010 for Open SCAP Library by  doxygen 1.6.1