1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
\hypertarget{structoval__state}{
\section{oval\_\-state Struct Reference}
\label{structoval__state}\index{oval\_\-state@{oval\_\-state}}
}
An Oval\_\-state instance is a collection of one or more characteristics pertaining to a specific object type.
{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{structoval__state}{oval\_\-state} $\ast$ \hyperlink{group__OVALDEF_ga232ee583317c4e71772f75ff13d0f74c}{oval\_\-state\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$, const char $\ast$id)
\begin{DoxyCompactList}\small\item\em Construct new intance of \hyperlink{structoval__state}{oval\_\-state}. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__state}{oval\_\-state} $\ast$ \hyperlink{group__OVALDEF_gaa7951fab775252622de5d3d1b2a8a0f0}{oval\_\-state\_\-clone} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$new\_\-model, struct \hyperlink{structoval__state}{oval\_\-state} $\ast$old\_\-state)
\begin{DoxyCompactList}\small\item\em Clone instance of \hyperlink{structoval__state}{oval\_\-state} and add it to the specified \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model}. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gae570dacf481fc02cfdf3420a53b91b29}{
void \hyperlink{group__OVALDEF_gae570dacf481fc02cfdf3420a53b91b29}{oval\_\-state\_\-free} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_gae570dacf481fc02cfdf3420a53b91b29}
\begin{DoxyCompactList}\small\item\em Free instance of \hyperlink{structoval__state}{oval\_\-state}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
}\begin{DoxyCompactItemize}
\item
void \hyperlink{group__OVALDEF_ga312270d697ba5aec73b0765a0b572d57}{oval\_\-state\_\-set\_\-subtype} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, \hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} subtype)
\begin{DoxyCompactList}\small\item\em Sets attributes \hyperlink{structoval__state}{oval\_\-state}-\/$>$subtype and \hyperlink{structoval__state}{oval\_\-state}-\/$>$family. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga9371475d9d286345d880e24b7d6297ff}{oval\_\-state\_\-add\_\-note} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, char $\ast$note)
\begin{DoxyCompactList}\small\item\em Appends a copy of the note parameter to attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$notes. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga81844120fd22784391967ae54f4815cd}{oval\_\-state\_\-set\_\-comment} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, char $\ast$comment)
\begin{DoxyCompactList}\small\item\em Sets a copy of the comment parameter to attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$comment. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga81d256f6e88910ad6bf1c70ee3a73c1d}{
void \hyperlink{group__OVALDEF_ga81d256f6e88910ad6bf1c70ee3a73c1d}{oval\_\-state\_\-set\_\-deprecated} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, bool deprecated)}
\label{group__OVALDEF_ga81d256f6e88910ad6bf1c70ee3a73c1d}
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$deprecated. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga4de8c320f537f7636691ea7bc1898ed2}{oval\_\-state\_\-set\_\-version} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, int version)
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$version. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga8b4a079d27e320bd135a8a3314a9b141}{
void \hyperlink{group__OVALDEF_ga8b4a079d27e320bd135a8a3314a9b141}{oval\_\-state\_\-set\_\-operator} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, \hyperlink{group__OVALDEF_gad5debd6ffe0c38c6de9108e86ee237e6}{oval\_\-operator\_\-t})}
\label{group__OVALDEF_ga8b4a079d27e320bd135a8a3314a9b141}
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$operator. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga4d65d2f430c82dd92d5822728aa86e1f}{oval\_\-state\_\-add\_\-content} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$, struct \hyperlink{structoval__state__content}{oval\_\-state\_\-content} $\ast$content)
\begin{DoxyCompactList}\small\item\em Append instance of \hyperlink{structoval__state__content}{oval\_\-state\_\-content} to attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$state\_\-contents. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALDEF_ga8693c2d07171ce7fa37cd41b253a9348}{
\hyperlink{group__OVAL_ga83b7e728a31f7ad0a0306ec1408f0a1a}{oval\_\-family\_\-t} \hyperlink{group__OVALDEF_ga8693c2d07171ce7fa37cd41b253a9348}{oval\_\-state\_\-get\_\-family} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_ga8693c2d07171ce7fa37cd41b253a9348}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$family. \item\end{DoxyCompactList}\item
const char $\ast$ \hyperlink{group__OVALDEF_ga685f5e181ecde5479106f1b72030013d}{oval\_\-state\_\-get\_\-name} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns the name of an \hyperlink{structoval__state}{oval\_\-state}. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gadb8affdb7564eff0b6b5ef3ee3f73512}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} \hyperlink{group__OVALDEF_gadb8affdb7564eff0b6b5ef3ee3f73512}{oval\_\-state\_\-get\_\-subtype} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_gadb8affdb7564eff0b6b5ef3ee3f73512}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$subtype. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga2a3675893b4241ffdee4447f7d1aa3f2}{oval\_\-state\_\-get\_\-notes} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$notes. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__OVALDEF_ga8edde47e7d781d442cbc8e5fdf37e9b7}{oval\_\-state\_\-get\_\-comment} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$comment. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__OVALDEF_ga72a7ee9bae3338e20ff89aa51b0d95d0}{oval\_\-state\_\-get\_\-id} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$id. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga272d726ebb434d85c0c9b084e88e3b17}{
bool \hyperlink{group__OVALDEF_ga272d726ebb434d85c0c9b084e88e3b17}{oval\_\-state\_\-get\_\-deprecated} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_ga272d726ebb434d85c0c9b084e88e3b17}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$deprecated. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga989cf2ff0a094e5d1b7ee107cc0bfdc9}{
int \hyperlink{group__OVALDEF_ga989cf2ff0a094e5d1b7ee107cc0bfdc9}{oval\_\-state\_\-get\_\-version} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_ga989cf2ff0a094e5d1b7ee107cc0bfdc9}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$version. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gaab999ca597b76309cc58214d2023a678}{
int \hyperlink{group__OVALDEF_gaab999ca597b76309cc58214d2023a678}{oval\_\-state\_\-get\_\-operator} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)}
\label{group__OVALDEF_gaab999ca597b76309cc58214d2023a678}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$operator. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__state__content__iterator}{oval\_\-state\_\-content\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga6d38e6821748f4daf018ad5d02bbbb7d}{oval\_\-state\_\-get\_\-contents} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__state}{oval\_\-state}-\/$>$contents. \item\end{DoxyCompactList}\item
bool \hyperlink{group__OVALDEF_gaeccb92e8e04d7d3956691cf54af475b5}{oval\_\-state\_\-is\_\-locked} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$state)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the state instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALDEF_gaa4592d5952783461c231ac22b3a76c09}{
bool \hyperlink{group__OVALDEF_gaa4592d5952783461c231ac22b3a76c09}{oval\_\-state\_\-is\_\-valid} (struct \hyperlink{structoval__state}{oval\_\-state} $\ast$state)}
\label{group__OVALDEF_gaa4592d5952783461c231ac22b3a76c09}
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the state instance is valid An Oval\_\-state is valid if all of the following are true
\begin{DoxyItemize}
\item All included state contents are valid.
\end{DoxyItemize}\item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structoval__state_a124c6f0bcfbe7b14194d90223192ce78}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__state_a124c6f0bcfbe7b14194d90223192ce78}
\item
\hypertarget{structoval__state_a9e08fa3032accfc99644d8c881dd0658}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} {\bfseries subtype}}
\label{structoval__state_a9e08fa3032accfc99644d8c881dd0658}
\item
\hypertarget{structoval__state_a63389d0532ee823a4791e80ceb5efefb}{
char $\ast$ {\bfseries comment}}
\label{structoval__state_a63389d0532ee823a4791e80ceb5efefb}
\item
\hypertarget{structoval__state_ac38771338ecd5ed1d040684445748bfe}{
char $\ast$ {\bfseries id}}
\label{structoval__state_ac38771338ecd5ed1d040684445748bfe}
\item
\hypertarget{structoval__state_adc7bdb003872449c0e73c2d662e858dd}{
int {\bfseries deprecated}}
\label{structoval__state_adc7bdb003872449c0e73c2d662e858dd}
\item
\hypertarget{structoval__state_ad9fa3609d73637d4bf900c119c639da8}{
int {\bfseries version}}
\label{structoval__state_ad9fa3609d73637d4bf900c119c639da8}
\item
\hypertarget{structoval__state_a024fccf2c13fba5acdaef5d9f0361c9c}{
\hyperlink{group__OVALDEF_gad5debd6ffe0c38c6de9108e86ee237e6}{oval\_\-operator\_\-t} {\bfseries operator}}
\label{structoval__state_a024fccf2c13fba5acdaef5d9f0361c9c}
\item
\hypertarget{structoval__state_a838c353b5a894a7866a2c44f63052992}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries notes}}
\label{structoval__state_a838c353b5a894a7866a2c44f63052992}
\item
\hypertarget{structoval__state_a4a57e76e0769e6ec010d2ad60d8e1afe}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries contents}}
\label{structoval__state_a4a57e76e0769e6ec010d2ad60d8e1afe}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
An Oval\_\-state instance is a collection of one or more characteristics pertaining to a specific object type. The Oval\_\-state is used by an during the evaluation of an Oval\_\-test to determine if a set of items queried by an Oval\_\-object on a instrumented host meet certain characteristics.
The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/\hyperlink{oval__state_8c}{oval\_\-state.c}\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/public/\hyperlink{oval__definitions_8h}{oval\_\-definitions.h}\end{DoxyCompactItemize}
|
