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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
\hypertarget{structxccdf__item}{
\section{xccdf\_\-item Struct Reference}
\label{structxccdf__item}\index{xccdf\_\-item@{xccdf\_\-item}}
}
A base class for XCCDF items.
{\ttfamily \#include $<$xccdf.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
void \hyperlink{group__XCCDF_gade5fdd83920aff929bd29f338e8c8549}{xccdf\_\-item\_\-free} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_ga81c2ee40fc23c73b0ac1ca118e4130ca}{xccdf\_\-item\_\-clone} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$old\_\-item)
\item
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_gabb8cd5cb505ba695bfd7acff400b5bc2}{xccdf\_\-item\_\-to\_\-benchmark} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a benchmark. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__profile}{xccdf\_\-profile} $\ast$ \hyperlink{group__XCCDF_gaaf6d05d4ec9f3b06aae0fba81a6db3f5}{xccdf\_\-item\_\-to\_\-profile} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a profile. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__rule}{xccdf\_\-rule} $\ast$ \hyperlink{group__XCCDF_ga678afb2bfa7aaf0d70550786d9fac2f0}{xccdf\_\-item\_\-to\_\-rule} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a rule. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__group}{xccdf\_\-group} $\ast$ \hyperlink{group__XCCDF_ga1081781c7d2f1c143837a6830e301df1}{xccdf\_\-item\_\-to\_\-group} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a group. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$ \hyperlink{group__XCCDF_ga0112c34d94dfcb6a51bc3cfd71de02f3}{xccdf\_\-item\_\-to\_\-value} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a value. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__result}{xccdf\_\-result} $\ast$ \hyperlink{group__XCCDF_ga08d6dc4cf86680c9efced168687348e6}{xccdf\_\-item\_\-to\_\-result} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Convert the item to a test result. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
Return value is pointer to structure's member.
Do not free unless you null the pointer in the structure. Use remove function otherwise. }\begin{DoxyCompactItemize}
\item
\hypertarget{group__XCCDF_gab2d57ffd6182ad37fc524752a176ee8f}{
\hyperlink{group__XCCDF_ga1c722a7917110bdb164e21e75ed6cfa6}{xccdf\_\-type\_\-t} {\bfseries xccdf\_\-item\_\-get\_\-type} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gab2d57ffd6182ad37fc524752a176ee8f}
\item
\hypertarget{group__XCCDF_gab76134e1c1edbd16446c8386b188c5bc}{
const char $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-id} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gab76134e1c1edbd16446c8386b188c5bc}
\item
\hypertarget{group__XCCDF_ga5379376888d769ea81bcb25ab920da1c}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-title} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga5379376888d769ea81bcb25ab920da1c}
\item
\hypertarget{group__XCCDF_ga585471c8209d6f27fdd43323f65b97de}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-description} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga585471c8209d6f27fdd43323f65b97de}
\item
\hypertarget{group__XCCDF_ga703a5852f4dbd5b2cf9b11e6a49fcfce}{
const char $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-version} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga703a5852f4dbd5b2cf9b11e6a49fcfce}
\item
\hypertarget{group__XCCDF_ga381d2fc6d0d37aeb24fc86cd5acfd4ec}{
const char $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-extends} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga381d2fc6d0d37aeb24fc86cd5acfd4ec}
\item
\hypertarget{group__XCCDF_ga34a1abdde6b2b3f5503fad795d9a3217}{
struct \hyperlink{structxccdf__status__iterator}{xccdf\_\-status\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-statuses} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga34a1abdde6b2b3f5503fad795d9a3217}
\item
\hypertarget{group__XCCDF_gaf0dd88cec247866a006b1f1302250f90}{
struct \hyperlink{structxccdf__reference__iterator}{xccdf\_\-reference\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-references} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gaf0dd88cec247866a006b1f1302250f90}
\item
\hypertarget{group__XCCDF_ga81e9d3e9e841257183264d04d60bddac}{
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-conflicts} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga81e9d3e9e841257183264d04d60bddac}
\item
\hypertarget{group__XCCDF_ga28eb0a60382220e47e558f46e79abf93}{
struct \hyperlink{structoscap__stringlist__iterator}{oscap\_\-stringlist\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-requires} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga28eb0a60382220e47e558f46e79abf93}
\item
\hypertarget{group__XCCDF_ga26be4e78986cc02e5a4906f3cc4b3956}{
\hyperlink{group__XCCDF_gac0d5c1c85828e13ebb13935551f8da38}{xccdf\_\-status\_\-type\_\-t} {\bfseries xccdf\_\-item\_\-get\_\-current\_\-status} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga26be4e78986cc02e5a4906f3cc4b3956}
\item
\hypertarget{group__XCCDF_ga841d013f75eeeeebc2c761d48cbe67a4}{
bool {\bfseries xccdf\_\-item\_\-get\_\-hidden} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga841d013f75eeeeebc2c761d48cbe67a4}
\item
\hypertarget{group__XCCDF_ga97b173a0b84a0f95cf4d71021c7a9a4f}{
bool {\bfseries xccdf\_\-item\_\-get\_\-selected} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga97b173a0b84a0f95cf4d71021c7a9a4f}
\item
\hypertarget{group__XCCDF_gab764cdbfde342af551239ff6e30bf0f0}{
bool {\bfseries xccdf\_\-item\_\-get\_\-prohibit\_\-changes} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gab764cdbfde342af551239ff6e30bf0f0}
\item
\hypertarget{group__XCCDF_ga80c1d10ae065c4d89fc642b32deff3f4}{
bool {\bfseries xccdf\_\-item\_\-get\_\-abstract} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_ga80c1d10ae065c4d89fc642b32deff3f4}
\item
\hypertarget{group__XCCDF_gaca66cdf017e3eabf544c4d0f5822ad1b}{
bool {\bfseries xccdf\_\-item\_\-get\_\-interactive} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gaca66cdf017e3eabf544c4d0f5822ad1b}
\item
\hypertarget{group__XCCDF_gad49c858df4aa8e2dbf6ac5997766f366}{
struct \hyperlink{structxccdf__item__iterator}{xccdf\_\-item\_\-iterator} $\ast$ {\bfseries xccdf\_\-item\_\-get\_\-content} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)}
\label{group__XCCDF_gad49c858df4aa8e2dbf6ac5997766f366}
\item
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_ga1aa026748670bdb35f9493309af377d4}{xccdf\_\-item\_\-get\_\-parent} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em Return item's parent in the grouping hierarchy. \item\end{DoxyCompactList}\item
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gab4af0809bd3555164c610dd11ccd8063}{xccdf\_\-item\_\-get\_\-question} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
struct \hyperlink{structxccdf__warning__iterator}{xccdf\_\-warning\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga934d5afc284cd8a95c67592aa135c001}{xccdf\_\-item\_\-get\_\-warnings} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga44e972c1e902a83186f4f66fc82f2ca8}{xccdf\_\-item\_\-get\_\-rationale} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
const char $\ast$ \hyperlink{group__XCCDF_ga7158bf7eaf418efd9bb1702771a78cb9}{xccdf\_\-item\_\-get\_\-cluster\_\-id} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
const char $\ast$ \hyperlink{group__XCCDF_gadd1a40adb7c180b660c49169cb3d987e}{xccdf\_\-item\_\-get\_\-version\_\-update} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
time\_\-t \hyperlink{group__XCCDF_ga7c948fdd6de2a476d8e603862e7292ea}{xccdf\_\-item\_\-get\_\-version\_\-time} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
float \hyperlink{group__XCCDF_gad26e4ec4aae2f1e6ce825df029db0316}{xccdf\_\-item\_\-get\_\-weight} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_gaff197e1d8facaa788f37529dfada7526}{xccdf\_\-item\_\-get\_\-benchmark} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\item
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga31b10a1ee35af89d6df383ec3df19e4c}{xccdf\_\-item\_\-get\_\-platforms} (const struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
For lists use add functions.
Parameters of set functions are duplicated in memory and need to be freed by caller. }\begin{DoxyCompactItemize}
\item
bool \hyperlink{group__XCCDF_ga24d4c52cdeea8b0815e6bb55036353cf}{xccdf\_\-item\_\-set\_\-weight} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, \hyperlink{group__XCCDF_ga83ab7d5052d01468f373732e268f47b4}{xccdf\_\-numeric} newval)
\item
bool \hyperlink{group__XCCDF_ga596edc97baaa93314506c1df1aa92047}{xccdf\_\-item\_\-set\_\-id} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gab216410a559939ae91d051c679e70f68}{xccdf\_\-item\_\-set\_\-cluster\_\-id} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga270b34ceee5dbd077eaed29379a6f359}{xccdf\_\-item\_\-set\_\-extends} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga07296fff86f2ee66f74f705ad3bdf3ee}{xccdf\_\-item\_\-set\_\-version} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga14043d866e9e3ad3ef659cd60c471e00}{xccdf\_\-item\_\-set\_\-version\_\-time} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, time\_\-t newval)
\item
bool \hyperlink{group__XCCDF_gad1c1c2e65384aa43946bacde19254f1a}{xccdf\_\-item\_\-set\_\-version\_\-update} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga931fde4491fbe4eb98447cd20db19da4}{xccdf\_\-item\_\-set\_\-abstract} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_ga9ccbbbf6f99676fc098a5b1333a335e4}{xccdf\_\-item\_\-set\_\-hidden} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_ga37df2c91c8b34c45ea5f16154159f4df}{xccdf\_\-item\_\-set\_\-interactive} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_gaf1b960ff7cc117f0579edec1569b9c19}{xccdf\_\-item\_\-set\_\-prohibit\_\-changes} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_ga853cf91c7e4ff57c39f6d1a8541a37cb}{xccdf\_\-item\_\-set\_\-selected} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_ga142c2fd792e0f4cc9ff16562c100ca4a}{xccdf\_\-item\_\-add\_\-description} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga37a171afdafacdc85f890a53084a2941}{xccdf\_\-item\_\-add\_\-platform} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga90efa00720237f055011fc5ae2b09a68}{xccdf\_\-item\_\-add\_\-question} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga37e02de79b2fcf74ddaf685de2a3ad09}{xccdf\_\-item\_\-add\_\-rationale} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gabc13b36036d4d2e2477854e686d39b43}{xccdf\_\-item\_\-add\_\-reference} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structxccdf__reference}{xccdf\_\-reference} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga0277092bd5e0eed6b4c7ecc6817f4af6}{xccdf\_\-item\_\-add\_\-status} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structxccdf__status}{xccdf\_\-status} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gaccb73f58cea4d14967e48a4eca828b08}{xccdf\_\-item\_\-add\_\-title} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga4bc0c8f377b0157d313ca89dfa2f2c55}{xccdf\_\-item\_\-add\_\-warning} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, struct \hyperlink{structxccdf__warning}{xccdf\_\-warning} $\ast$newval)
\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structxccdf__item_a6e2f2f1d0f2daffc827355ff6e954744}{
\hyperlink{group__XCCDF_ga1c722a7917110bdb164e21e75ed6cfa6}{xccdf\_\-type\_\-t} {\bfseries type}}
\label{structxccdf__item_a6e2f2f1d0f2daffc827355ff6e954744}
\item
\hypertarget{structxccdf__item_a7c410fdf6b784fac893292ba316d252d}{
struct \hyperlink{structxccdf__item__base}{xccdf\_\-item\_\-base} {\bfseries item}}
\label{structxccdf__item_a7c410fdf6b784fac893292ba316d252d}
\item
\hypertarget{structxccdf__item_aa0a5a670bd98eb66ecb4dc59f0a46670}{
\begin{tabbing}
xx\=xx\=xx\=xx\=xx\=xx\=xx\=xx\=xx\=\kill
union \{\\
\>struct \hyperlink{structxccdf__profile__item}{xccdf\_profile\_item} {\bfseries profile}\\
\>struct \hyperlink{structxccdf__benchmark__item}{xccdf\_benchmark\_item} {\bfseries benchmark}\\
\>struct \hyperlink{structxccdf__rule__item}{xccdf\_rule\_item} {\bfseries rule}\\
\>struct \hyperlink{structxccdf__group__item}{xccdf\_group\_item} {\bfseries group}\\
\>struct \hyperlink{structxccdf__value__item}{xccdf\_value\_item} {\bfseries value}\\
\>struct \hyperlink{structxccdf__result__item}{xccdf\_result\_item} {\bfseries result}\\
\} {\bfseries sub}}
\label{structxccdf__item_aa0a5a670bd98eb66ecb4dc59f0a46670}
\\
\end{tabbing}\end{DoxyCompactItemize}
\subsection{Detailed Description}
A base class for XCCDF items.
The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/XCCDF/item.h\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/XCCDF/public/\hyperlink{xccdf_8h}{xccdf.h}\end{DoxyCompactItemize}
|
