xccdf_benchmark Struct Reference
[XCCDF]

Top level XCCDF structure containing profiles, rules, values and results. 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.
struct xccdf_benchmarkxccdf_benchmark_new (void)
void xccdf_benchmark_free (struct xccdf_benchmark *benchmark)
struct xccdf_itemxccdf_benchmark_to_item (struct xccdf_benchmark *item)
const char * xccdf_benchmark_supported (void)
 Get supported version of XCCDF XML.
struct xccdf_benchmarkxccdf_benchmark_create (const char *id)
 Create a new benchmark from a benchmark XML file.
Getters

Return value is pointer to structure's member.

Do not free unless you null the pointer in the structure. Use remove function otherwise.



const char * xccdf_benchmark_get_id (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_resolved (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_title (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_description (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_version (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_style (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_style_href (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_front_matter (const struct xccdf_benchmark *benchmark)
struct oscap_text_iteratorxccdf_benchmark_get_rear_matter (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_metadata (const struct xccdf_benchmark *benchmark)
struct xccdf_status_iteratorxccdf_benchmark_get_statuses (const struct xccdf_benchmark *benchmark)
struct xccdf_reference_iteratorxccdf_benchmark_get_references (const struct xccdf_benchmark *benchmark)
struct oscap_string_iteratorxccdf_benchmark_get_platforms (const struct xccdf_benchmark *benchmark)
xccdf_status_type_t xccdf_benchmark_get_status_current (const struct xccdf_benchmark *benchmark)
struct xccdf_plain_text_iteratorxccdf_benchmark_get_plain_texts (const struct xccdf_benchmark *item)
struct xccdf_result_iteratorxccdf_benchmark_get_results (const struct xccdf_benchmark *bench)
struct xccdf_value_iteratorxccdf_benchmark_get_values (const struct xccdf_benchmark *item)
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_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.
struct xccdf_warning_iteratorxccdf_benchmark_get_warnings (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)
Setters

For lists use add functions.

Parameters of set functions are duplicated in memory and need to be freed by caller.



bool xccdf_benchmark_set_resolved (struct xccdf_benchmark *item, bool newval)
bool xccdf_benchmark_set_metadata (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_set_style_href (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_set_style (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_set_id (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_set_version (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_set_version_time (struct xccdf_benchmark *item, time_t newval)
bool xccdf_benchmark_set_version_update (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_add_result (struct xccdf_benchmark *bench, struct xccdf_result *result)
bool xccdf_benchmark_add_description (struct xccdf_benchmark *item, struct oscap_text *newval)
bool xccdf_benchmark_add_platform (struct xccdf_benchmark *item, const char *newval)
bool xccdf_benchmark_add_reference (struct xccdf_benchmark *item, struct xccdf_reference *newval)
bool xccdf_benchmark_add_status (struct xccdf_benchmark *item, struct xccdf_status *newval)
bool xccdf_benchmark_add_title (struct xccdf_benchmark *item, struct oscap_text *newval)
bool xccdf_benchmark_add_front_matter (struct xccdf_benchmark *item, struct oscap_text *newval)
bool xccdf_benchmark_add_model (struct xccdf_benchmark *item, struct xccdf_model *newval)
bool xccdf_benchmark_add_notice (struct xccdf_benchmark *item, struct xccdf_notice *newval)
bool xccdf_benchmark_add_plain_text (struct xccdf_benchmark *item, struct xccdf_plain_text *newval)
bool xccdf_benchmark_add_profile (struct xccdf_benchmark *item, struct xccdf_profile *newval)
bool xccdf_benchmark_add_rear_matter (struct xccdf_benchmark *item, struct oscap_text *newval)
bool xccdf_benchmark_add_rule (struct xccdf_benchmark *benchmark, struct xccdf_rule *rule)
bool xccdf_benchmark_add_group (struct xccdf_benchmark *benchmark, struct xccdf_group *group)
bool xccdf_benchmark_add_value (struct xccdf_benchmark *benchmark, struct xccdf_value *value)
bool xccdf_benchmark_add_content (struct xccdf_benchmark *bench, struct xccdf_item *item)

Detailed Description

Top level XCCDF structure containing profiles, rules, values and results.


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

Generated on 7 May 2010 for Open SCAP Library by  doxygen 1.6.1