OVALVAR

OVAL Variables API. More...

Data Structures

struct  oval_variable_model
 OVAL variable model. More...

Functions

struct oval_variable_modeloval_variable_model_new (void)
 Create a new OVAL variable model.
struct oval_variable_modeloval_variable_model_clone (struct oval_variable_model *)
 Create an OVAL variable model.
void oval_variable_model_free (struct oval_variable_model *)
 Free memory allocated to a specified oval_variable_model.
void oval_variable_model_import (struct oval_variable_model *, struct oval_import_source *, oval_xml_error_handler, void *)
 Load the specified oval_variable_model from an XML stream.
void oval_variable_model_export (struct oval_variable_model *, struct oval_export_target *)
 Export the specified oval_variable_model to an XML stream.
struct oval_string_iterator * 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_get_datatype (struct oval_variable_model *, char *)
 Get a specified external variable datatype.
const char * oval_variable_model_get_comment (struct oval_variable_model *, char *)
 Get a specified external variable comment.
struct oval_string_iterator * oval_variable_model_get_values (struct oval_variable_model *, char *)
 Get the values bound to a specified external variable.
void oval_variable_model_add (struct oval_variable_model *model, char *varid, const char *comment, oval_datatype_t datatype, char *value)

Detailed Description

OVAL Variables API.


Function Documentation

void oval_variable_model_export ( struct oval_variable_model ,
struct oval_export_target  
)

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 oval_export_target that resolves the output XML stream.
void oval_variable_model_free ( struct oval_variable_model  ) 

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 *   
)

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 *   
)

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]

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]

Get all external variables managed by a specified oval_variable_model.

Parameters:
variable_model the specified oval_variable_model.
void oval_variable_model_import ( struct oval_variable_model ,
struct oval_import_source ,
oval_xml_error_handler  ,
void *   
)

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 oval_import_source that resolves the XML stream.
error_handler the oval_xml_error_handler that tracks the parsing of the XML stream (may be NULL)
user_param a user parameter that is passed the the error handler implementation.

Generated on 12 Nov 2009 for Open SCAP Library by  doxygen 1.6.1