xccdf_value Struct Reference
[XCCDFXCCDF Value]

XCCDF Value. More...

#include <xccdf.h>

Public Member Functions

const char * xccdf_value_get_id (const struct xccdf_value *value)
struct oscap_text_iteratorxccdf_value_get_title (const struct xccdf_value *value)
struct oscap_text_iteratorxccdf_value_get_description (const struct xccdf_value *value)
const char * xccdf_value_get_extends (const struct xccdf_value *value)
bool xccdf_value_get_abstract (const struct xccdf_value *value)
bool xccdf_value_get_prohibit_changes (const struct xccdf_value *value)
bool xccdf_value_get_hidden (const struct xccdf_value *value)
bool xccdf_value_get_interactive (const struct xccdf_value *value)
struct xccdf_status_iteratorxccdf_value_get_statuses (const struct xccdf_value *value)
struct xccdf_reference_iteratorxccdf_value_get_references (const struct xccdf_value *value)
xccdf_status_type_t xccdf_value_get_status_current (const struct xccdf_value *value)
xccdf_value_type_t xccdf_value_get_type (const struct xccdf_value *value)
xccdf_interface_hint_t xccdf_value_get_interface_hint (const struct xccdf_value *value)
xccdf_operator_t xccdf_value_get_oper (const struct xccdf_value *value)
const char * xccdf_value_get_selector (const struct xccdf_value *value)
struct xccdf_itemxccdf_value_to_item (struct xccdf_value *item)
bool xccdf_value_set_id (struct xccdf_value *item, const char *newval)
bool xccdf_value_set_cluster_id (struct xccdf_value *item, const char *newval)
bool xccdf_value_set_extends (struct xccdf_value *item, const char *newval)
bool xccdf_value_set_version (struct xccdf_value *item, const char *newval)
bool xccdf_value_set_version_time (struct xccdf_value *item, time_t newval)
bool xccdf_value_set_version_update (struct xccdf_value *item, const char *newval)
bool xccdf_value_add_description (struct xccdf_value *item, struct oscap_text *newval)
bool xccdf_value_add_question (struct xccdf_value *item, struct oscap_text *newval)
bool xccdf_value_add_reference (struct xccdf_value *item, struct xccdf_reference *newval)
bool xccdf_value_add_status (struct xccdf_value *item, struct xccdf_status *newval)
bool xccdf_value_add_title (struct xccdf_value *item, struct oscap_text *newval)
bool xccdf_value_add_warning (struct xccdf_value *item, struct xccdf_warning *newval)
struct xccdf_itemxccdf_value_get_parent (const struct xccdf_value *value)
 Return value's parent in the grouping hierarchy.
bool xccdf_value_get_set_selector (struct xccdf_item *value, const char *selector)
 Apply a selector on the value.
const char * xccdf_value_get_value_string (const struct xccdf_value *value)
 Return the item's value as a string.
xccdf_numeric xccdf_value_get_value_number (const struct xccdf_value *value)
 Return the item's value as a number.
bool xccdf_value_get_value_boolean (const struct xccdf_value *value)
 Return the item's value as a boolean value.
const char * xccdf_value_get_defval_string (const struct xccdf_value *value)
 Return the item's default value as a string.
xccdf_numeric xccdf_value_get_defval_number (const struct xccdf_value *value)
 Return the item's default value as a number.
bool xccdf_value_get_defval_boolean (const struct xccdf_value *value)
 Return the item's default value as a boolean value.
xccdf_numeric xccdf_value_get_lower_bound (const struct xccdf_value *value)
 Return upper limit for the numeric value.
xccdf_numeric xccdf_value_get_upper_bound (const struct xccdf_value *value)
 Return lower limit for the numeric value.
const char * xccdf_value_get_match (const struct xccdf_value *value)
 Regex the values should match.
bool xccdf_value_get_must_match (const struct xccdf_value *value)
 Return mustMatch property.
const char * xccdf_value_get_version (const struct xccdf_value *value)
struct oscap_text_iteratorxccdf_value_get_question (const struct xccdf_value *value)
struct xccdf_warning_iteratorxccdf_value_get_warnings (const struct xccdf_value *value)
const char * xccdf_value_get_version_update (const struct xccdf_value *value)
time_t xccdf_value_get_version_time (const struct xccdf_value *value)
struct xccdf_benchmarkxccdf_value_get_benchmark (const struct xccdf_value *value)
struct oscap_string_iteratorxccdf_value_get_sources (const struct xccdf_value *value)
const char * xccdf_value_get_cluster_id (const struct xccdf_value *value)

Detailed Description

XCCDF Value.


Member Function Documentation

bool xccdf_value_add_description ( struct xccdf_value item,
struct oscap_text newval 
)
bool xccdf_value_add_question ( struct xccdf_value item,
struct oscap_text newval 
)
bool xccdf_value_add_reference ( struct xccdf_value item,
struct xccdf_reference newval 
)
bool xccdf_value_add_status ( struct xccdf_value item,
struct xccdf_status newval 
)
bool xccdf_value_add_title ( struct xccdf_value item,
struct oscap_text newval 
)
bool xccdf_value_add_warning ( struct xccdf_value item,
struct xccdf_warning newval 
)
bool xccdf_value_get_abstract ( const struct xccdf_value value  ) 
struct xccdf_benchmark * xccdf_value_get_benchmark ( const struct xccdf_value value  )  [read]
const char * xccdf_value_get_cluster_id ( const struct xccdf_value value  ) 
bool xccdf_value_get_defval_boolean ( const struct xccdf_value value  ) 

Return the item's default value as a boolean value.

Implicit conversion is performed on non-boolean types: value is true for nonempty strings and nonzero numbers.

Returns:
boolean value
xccdf_numeric xccdf_value_get_defval_number ( const struct xccdf_value value  ) 

Return the item's default value as a number.

Returns:
numeric value
Return values:
NAN if value is not a number or is not set.
const char * xccdf_value_get_defval_string ( const struct xccdf_value value  ) 

Return the item's default value as a string.

Returns:
string value
Return values:
NULL if value is not a string or is not set
struct oscap_text_iterator * xccdf_value_get_description ( const struct xccdf_value value  )  [read]
const char * xccdf_value_get_extends ( const struct xccdf_value value  ) 
bool xccdf_value_get_hidden ( const struct xccdf_value value  ) 
const char * xccdf_value_get_id ( const struct xccdf_value value  ) 
bool xccdf_value_get_interactive ( const struct xccdf_value value  ) 
xccdf_interface_hint_t xccdf_value_get_interface_hint ( const struct xccdf_value value  ) 
xccdf_numeric xccdf_value_get_lower_bound ( const struct xccdf_value value  ) 

Return upper limit for the numeric value.

Return values:
NAN if value is not a number or lower limit is not set.
const char * xccdf_value_get_match ( const struct xccdf_value value  ) 

Regex the values should match.

Return values:
NULL if regex was not set or the value is not a string.
bool xccdf_value_get_must_match ( const struct xccdf_value value  ) 

Return mustMatch property.

Returns whether value must match conditions given by choices, or these are just hints.

xccdf_operator_t xccdf_value_get_oper ( const struct xccdf_value value  ) 
struct xccdf_item * xccdf_value_get_parent ( const struct xccdf_value value  )  [read]

Return value's parent in the grouping hierarchy.

Returned item will be either a value or a benchmark.

bool xccdf_value_get_prohibit_changes ( const struct xccdf_value value  ) 
struct oscap_text_iterator * xccdf_value_get_question ( const struct xccdf_value value  )  [read]
struct xccdf_reference_iterator * xccdf_value_get_references ( const struct xccdf_value value  )  [read]
const char * xccdf_value_get_selector ( const struct xccdf_value value  ) 
bool xccdf_value_get_set_selector ( struct xccdf_item value,
const char *  selector 
)

Apply a selector on the value.

Parameters:
The selector character string.
Returns:
whether setting the new selector was successful
struct oscap_string_iterator * xccdf_value_get_sources ( const struct xccdf_value value  )  [read]
xccdf_status_type_t xccdf_value_get_status_current ( const struct xccdf_value value  ) 
struct xccdf_status_iterator * xccdf_value_get_statuses ( const struct xccdf_value value  )  [read]
struct oscap_text_iterator * xccdf_value_get_title ( const struct xccdf_value value  )  [read]
xccdf_value_type_t xccdf_value_get_type ( const struct xccdf_value value  ) 
xccdf_numeric xccdf_value_get_upper_bound ( const struct xccdf_value value  ) 

Return lower limit for the numeric value.

Return values:
NAN if value is not a number or upper limit is not set.
bool xccdf_value_get_value_boolean ( const struct xccdf_value value  ) 

Return the item's value as a boolean value.

Implicit conversion is performed on non-boolean types: value is true for nonempty strings and nonzero numbers.

Returns:
boolean value
xccdf_numeric xccdf_value_get_value_number ( const struct xccdf_value value  ) 

Return the item's value as a number.

Returns:
numeric value
Return values:
NAN if value is not a number or is not set.
const char * xccdf_value_get_value_string ( const struct xccdf_value value  ) 

Return the item's value as a string.

Returns:
string value
Return values:
NULL if value is not a string or is not set
const char * xccdf_value_get_version ( const struct xccdf_value value  ) 
time_t xccdf_value_get_version_time ( const struct xccdf_value value  ) 
const char * xccdf_value_get_version_update ( const struct xccdf_value value  ) 
struct xccdf_warning_iterator * xccdf_value_get_warnings ( const struct xccdf_value value  )  [read]
bool xccdf_value_set_cluster_id ( struct xccdf_value item,
const char *  newval 
)
bool xccdf_value_set_extends ( struct xccdf_value item,
const char *  newval 
)
bool xccdf_value_set_id ( struct xccdf_value item,
const char *  newval 
)
bool xccdf_value_set_version ( struct xccdf_value item,
const char *  newval 
)
bool xccdf_value_set_version_time ( struct xccdf_value item,
time_t  newval 
)
bool xccdf_value_set_version_update ( struct xccdf_value item,
const char *  newval 
)
struct xccdf_item * xccdf_value_to_item ( struct xccdf_value item  )  [read]

The documentation for this struct was generated from the following file:

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