xccdf_benchmark Struct Reference
[XCCDFXCCDF Benchmark]

XCCDF Benchmark. More...

#include <xccdf.h>

Public Member Functions

struct xccdf_benchmarkxccdf_benchmark_parse_xml (const char *filename)
 Create a new benmchmark from a benchmark XML file.
const char * xccdf_benchmark_get_id (const struct xccdf_benchmark *benchmark)
 Get benchmark ID.
bool xccdf_benchmark_get_resolved (const struct xccdf_benchmark *benchmark)
 Check benchmark resolved property.
struct oscap_text_iteratorxccdf_benchmark_get_title (const struct xccdf_benchmark *benchmark)
 Get benchmark title.
struct oscap_text_iteratorxccdf_benchmark_get_description (const struct xccdf_benchmark *benchmark)
 Get benchmark description.
const char * xccdf_benchmark_get_version (const struct xccdf_benchmark *benchmark)
 Get benchmark version.
const char * xccdf_benchmark_get_style (const struct xccdf_benchmark *benchmark)
 Get benchmark inline stylesheet.
const char * xccdf_benchmark_get_style_href (const struct xccdf_benchmark *benchmark)
 Get benchmark stylesheet URL.
struct oscap_text_iteratorxccdf_benchmark_get_front_matter (const struct xccdf_benchmark *benchmark)
 Get benchmark front matter.
struct oscap_text_iteratorxccdf_benchmark_get_rear_matter (const struct xccdf_benchmark *benchmark)
 Get benchmark rear matter.
const char * xccdf_benchmark_get_metadata (const struct xccdf_benchmark *benchmark)
 Get benchmark metadata.
const char * xccdf_benchmark_get_plain_text (const struct xccdf_benchmark *benchmark, const char *id)
 Get a plain text by ID.
struct xccdf_itemxccdf_benchmark_get_item (const struct xccdf_benchmark *benchmark, const char *id)
 Get benchmark item by ID.
struct xccdf_status_iteratorxccdf_benchmark_get_statuses (const struct xccdf_benchmark *benchmark)
 Get an iterator to benchmark statuses.
struct xccdf_reference_iteratorxccdf_benchmark_get_references (const struct xccdf_benchmark *benchmark)
 Get an iterator to the XCCDF references of the benchmark.
struct oscap_string_iteratorxccdf_benchmark_get_platforms (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark platforms.
struct xccdf_notice_iteratorxccdf_benchmark_get_notices (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark legal notices.
struct xccdf_model_iteratorxccdf_benchmark_get_models (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark scoring models.
struct xccdf_profile_iteratorxccdf_benchmark_get_profiles (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark XCCDF profiles.
struct xccdf_item_iteratorxccdf_benchmark_get_content (const struct xccdf_benchmark *benchmark)
 Get an iterator to the bencmark content.
xccdf_status_type_t xccdf_benchmark_get_status_current (const struct xccdf_benchmark *benchmark)
 Get benchmark current status.
void xccdf_benchmark_free (struct xccdf_benchmark *benchmark)
 Delete the benchmark.
const char * xccdf_benchmark_supported (void)
 Get supported version of XCCDF XML.
bool xccdf_benchmark_get_hidden (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_selected (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_multiple (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_prohibit_changes (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_abstract (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_interactive (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_question (const struct xccdf_benchmark *benchmark)
struct xccdf_warning_iteratorxccdf_benchmark_get_warnings (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_rationale (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_cluster_id (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_version_update (const struct xccdf_benchmark *benchmark)
time_t xccdf_benchmark_get_version_time (const struct xccdf_benchmark *benchmark)
float xccdf_benchmark_get_weight (const struct xccdf_benchmark *benchmark)
struct xccdf_benchmarkxccdf_benchmark_get_benchmark (const struct xccdf_benchmark *benchmark)
struct xccdf_itemxccdf_benchmark_get_parent (const struct xccdf_benchmark *benchmark)
struct xccdf_benchmarkxccdf_benchmark_create (const char *id)
 Create a new benchmark from a benchmark XML file.

Detailed Description

XCCDF Benchmark.


Member Function Documentation

struct xccdf_benchmark * xccdf_benchmark_create ( const char *  id  )  [read]

Create a new benchmark from a benchmark XML file.

Parameters:
id the benchmark identifier.
Returns:
Pointer to the new benchmark.
void xccdf_benchmark_free ( struct xccdf_benchmark benchmark  ) 

Delete the benchmark.

Parameters:
benchmark Benchmark to be deleted.
bool xccdf_benchmark_get_abstract ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_benchmark * xccdf_benchmark_get_benchmark ( const struct xccdf_benchmark benchmark  )  [read]
const char * xccdf_benchmark_get_cluster_id ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_item_iterator * xccdf_benchmark_get_content ( const struct xccdf_benchmark benchmark  )  [read]

Get an iterator to the bencmark content.

The items are either groups or rules.

See also:
xccdf_rule
xccdf_group
xccdf_item
bool xccdf_benchmark_get_hidden ( const struct xccdf_benchmark benchmark  ) 
bool xccdf_benchmark_get_interactive ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_item * xccdf_benchmark_get_item ( const struct xccdf_benchmark benchmark,
const char *  id 
) [read]

Get benchmark item by ID.

Parameters:
item ID
Returns:
Item with given ID
Return values:
NULL if no such item exists
struct xccdf_model_iterator * xccdf_benchmark_get_models ( const struct xccdf_benchmark benchmark  )  [read]

Get an iterator to the benchmark scoring models.

See also:
xccdf_model
bool xccdf_benchmark_get_multiple ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_notice_iterator * xccdf_benchmark_get_notices ( const struct xccdf_benchmark benchmark  )  [read]

Get an iterator to the benchmark legal notices.

See also:
xccdf_notice
struct xccdf_item * xccdf_benchmark_get_parent ( const struct xccdf_benchmark benchmark  )  [read]
const char * xccdf_benchmark_get_plain_text ( const struct xccdf_benchmark benchmark,
const char *  id 
)

Get a plain text by ID.

Parameters:
id ID of the plain text to get.
Returns:
Plain text content.
Return values:
NULL if given plain text does not exist
struct xccdf_profile_iterator * xccdf_benchmark_get_profiles ( const struct xccdf_benchmark benchmark  )  [read]

Get an iterator to the benchmark XCCDF profiles.

See also:
xccdf_profile
bool xccdf_benchmark_get_prohibit_changes ( const struct xccdf_benchmark benchmark  ) 
struct oscap_text_iterator * xccdf_benchmark_get_question ( const struct xccdf_benchmark benchmark  )  [read]
struct oscap_text_iterator * xccdf_benchmark_get_rationale ( const struct xccdf_benchmark benchmark  )  [read]
bool xccdf_benchmark_get_resolved ( const struct xccdf_benchmark benchmark  ) 

Check benchmark resolved property.

bool xccdf_benchmark_get_selected ( const struct xccdf_benchmark benchmark  ) 
const char * xccdf_benchmark_get_version ( const struct xccdf_benchmark benchmark  ) 

Get benchmark version.

time_t xccdf_benchmark_get_version_time ( const struct xccdf_benchmark benchmark  ) 
const char * xccdf_benchmark_get_version_update ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_warning_iterator * xccdf_benchmark_get_warnings ( const struct xccdf_benchmark benchmark  )  [read]
float xccdf_benchmark_get_weight ( const struct xccdf_benchmark benchmark  ) 
struct xccdf_benchmark * xccdf_benchmark_parse_xml ( const char *  filename  )  [read]

Create a new benmchmark from a benchmark XML file.

Parameters:
filename Name of the file to load the contents from.
Returns:
Pointer to the new benchmark.
Return values:
NULL on failure
const char * xccdf_benchmark_supported ( void   ) 

Get supported version of XCCDF XML.

Returns:
version of XML file format

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

Generated on 26 Feb 2010 for Open SCAP Library by  doxygen 1.6.1