Getters
[Oval_state]

Oval_state get methods. More...

Functions

bool oval_state_is_locked (struct oval_state *state)
 return true if the state instance is locked.
oval_family_t oval_state_get_family (struct oval_state *)
 Returns attribute Oval_state->family.
const char * oval_state_get_name (struct oval_state *)
 Returns the name of an Oval_state.
oval_subtype_t oval_state_get_subtype (struct oval_state *)
 Returns attribute Oval_state->subtype.
void oval_state_set_subtype (struct oval_state *, oval_subtype_t subtype)
 Sets attributes Oval_state->subtype and Oval_state->family.
struct oval_string_iterator * oval_state_get_notes (struct oval_state *)
 Returns attribute Oval_state->notes.
void oval_state_add_note (struct oval_state *, char *note)
 Appends a copy of the note parameter to attribute Oval_state->notes.
char * oval_state_get_comment (struct oval_state *)
 Returns attribute Oval_state->comment.
char * oval_state_get_id (struct oval_state *)
 Returns attribute Oval_state->id.
bool oval_state_get_deprecated (struct oval_state *)
 Returns attribute Oval_state->deprecated.
int oval_state_get_version (struct oval_state *)
 Returns attribute Oval_state->version.
struct
oval_state_content_iterator * 
oval_state_get_contents (struct oval_state *)
 Returns attribute Oval_state->contents.

Detailed Description

Oval_state get methods.


Function Documentation

void oval_state_add_note ( struct oval_state ,
char *  note 
)

Appends a copy of the note parameter to attribute Oval_state->notes.

See also:
oval_state_get_notes
Parameters:
note - (Not NULL) the text of the appended note.
char* oval_state_get_comment ( struct oval_state  ) 

Returns attribute Oval_state->comment.

See also:
oval_state_set_comment
struct oval_state_content_iterator* oval_state_get_contents ( struct oval_state  )  [read]

Returns attribute Oval_state->contents.

See also:
oval_state_add_state_content
bool oval_state_get_deprecated ( struct oval_state  ) 

Returns attribute Oval_state->deprecated.

See also:
oval_state_new
oval_state_set_deprecated
oval_family_t oval_state_get_family ( struct oval_state  ) 

Returns attribute Oval_state->family.

See also:
oval_state_set_subtype
char* oval_state_get_id ( struct oval_state  ) 

Returns attribute Oval_state->id.

See also:
oval_state_new
const char* oval_state_get_name ( struct oval_state  ) 

Returns the name of an Oval_state.

This is a convenience method that is equivalent to oval_subtype_get_text (oval_state_get_subtype)+"_state".

See also:
oval_state_set_name
struct oval_string_iterator* oval_state_get_notes ( struct oval_state  )  [read]

Returns attribute Oval_state->notes.

Note:
The iterator returned by this method should be freed by the calling application.
See also:
oval_state_add_note
oval_subtype_t oval_state_get_subtype ( struct oval_state  ) 

Returns attribute Oval_state->subtype.

See also:
oval_state_set_subtype
int oval_state_get_version ( struct oval_state  ) 

Returns attribute Oval_state->version.

See also:
oval_state_set_version
bool oval_state_is_locked ( struct oval_state state  ) 

return true if the state instance is locked.

The state of a locked instance cannot be changed.

void oval_state_set_subtype ( struct oval_state ,
oval_subtype_t  subtype 
)

Sets attributes Oval_state->subtype and Oval_state->family.

If Oval_state->subtype == OVAL_SUBTYPE_UNKNOWN and parameter subtype <> OVAL_SUBTYPE_UNKNOWN, this method shall overwrite Oval_state->subtype with the value of the subtype parameter and Oval_state->family with the value of oval_family_t corresponding to the specified subtype. Otherwise, the state of the Oval_state instance shall not be changed by this method.

See also:
oval_state_get_subtype
oval_state_get_family
Parameters:
subtype - the required subtype value.

Generated on 4 Jan 2010 for Open SCAP Library by  doxygen 1.6.1