File: structxccdf__value.tex

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (168 lines) | stat: -rw-r--r-- 15,744 bytes parent folder | download
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
\hypertarget{structxccdf__value}{
\section{xccdf\_\-value Struct Reference}
\label{structxccdf__value}\index{xccdf\_\-value@{xccdf\_\-value}}
}


XCCDF Value allows test parametrization or capturing output of tests.  


{\ttfamily \#include $<$xccdf.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$ \hyperlink{group__XCCDF_ga2630fe70bcccf78dce68efc8eeb81698}{xccdf\_\-value\_\-new} (\hyperlink{group__XCCDF_gaa2d75ea6d3cd6957100f532b2ab8e8a8}{xccdf\_\-value\_\-type\_\-t} type)
\item 
void \hyperlink{group__XCCDF_gaaa4a35976061da709d0e5962d2e4ae9a}{xccdf\_\-value\_\-free} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$val)
\item 
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_gaec1fafd17239b9b67cf17f03eb7297b4}{xccdf\_\-value\_\-to\_\-item} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item)
\item 
struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$ \hyperlink{group__XCCDF_ga0a1d4ebb0c533be84bc4d1d52abaf882}{xccdf\_\-value\_\-clone} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\end{DoxyCompactItemize}
\subsection*{Getters}
\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 
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gaf8ec5041c7685a2a15f1e98560a1c12f}{xccdf\_\-value\_\-get\_\-title} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
const char $\ast$ \hyperlink{group__XCCDF_ga24589b2df9508d1d849fcc94d2dfce6d}{xccdf\_\-value\_\-get\_\-id} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gaa0aa3640b18fe31b045d5e6f1d1cb6ca}{xccdf\_\-value\_\-get\_\-description} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
const char $\ast$ \hyperlink{group__XCCDF_gac34c93a463fa23916367974068c7d3fe}{xccdf\_\-value\_\-get\_\-extends} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
bool \hyperlink{group__XCCDF_gab6dee71045b36f274793aafef5fbb860}{xccdf\_\-value\_\-get\_\-abstract} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
bool \hyperlink{group__XCCDF_gaa32f1e98eb87cbcff9f3a23aee7c81bd}{xccdf\_\-value\_\-get\_\-prohibit\_\-changes} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
bool \hyperlink{group__XCCDF_ga1d672777099e90af7e5b59d2e915b4c3}{xccdf\_\-value\_\-get\_\-hidden} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
bool \hyperlink{group__XCCDF_ga569d0a208e0330c7dfd95805154d5824}{xccdf\_\-value\_\-get\_\-interactive} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structxccdf__status__iterator}{xccdf\_\-status\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gab09781ac557495cef4ac97c3d9d3ae7d}{xccdf\_\-value\_\-get\_\-statuses} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structxccdf__reference__iterator}{xccdf\_\-reference\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga94df2d4947539164fcd20f844b714c89}{xccdf\_\-value\_\-get\_\-references} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
\hyperlink{group__XCCDF_gac0d5c1c85828e13ebb13935551f8da38}{xccdf\_\-status\_\-type\_\-t} \hyperlink{group__XCCDF_ga0f89346d84439b56c0c1bfceaba2b46c}{xccdf\_\-value\_\-get\_\-status\_\-current} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
\hyperlink{group__XCCDF_gaa2d75ea6d3cd6957100f532b2ab8e8a8}{xccdf\_\-value\_\-type\_\-t} \hyperlink{group__XCCDF_gaf8b141e53cf56104124f7182751e36cd}{xccdf\_\-value\_\-get\_\-type} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
\hyperlink{group__XCCDF_ga11b376c782488525bddcfafa3bb92b96}{xccdf\_\-interface\_\-hint\_\-t} \hyperlink{group__XCCDF_ga4c2a287faf8c70346f84d648765443ce}{xccdf\_\-value\_\-get\_\-interface\_\-hint} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
\hyperlink{group__XCCDF_ga4458b04cd1236b95d15ac2d74276c09c}{xccdf\_\-operator\_\-t} \hyperlink{group__XCCDF_gaf3ffc6bc219979dafa40a8a8b764d7d1}{xccdf\_\-value\_\-get\_\-oper} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structxccdf__value__instance}{xccdf\_\-value\_\-instance} $\ast$ \hyperlink{group__XCCDF_ga44cadd2a97282022e1e15b08b0fb2b57}{xccdf\_\-value\_\-get\_\-instance\_\-by\_\-selector} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value, const char $\ast$selector)
\item 
bool \hyperlink{group__XCCDF_ga78ba61e2306d29f6aeea8368821cb91a}{xccdf\_\-value\_\-add\_\-instance} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value, struct \hyperlink{structxccdf__value__instance}{xccdf\_\-value\_\-instance} $\ast$instance)
\item 
struct \hyperlink{structxccdf__value__instance__iterator}{xccdf\_\-value\_\-instance\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gaababffc00c6d72a930ee1e53778b1c74}{xccdf\_\-value\_\-get\_\-instances} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item)
\item 
struct \hyperlink{structxccdf__value__instance}{xccdf\_\-value\_\-instance} $\ast$ \hyperlink{group__XCCDF_gab7a0ab69244d5e78969f06cdf6b3f1d1}{xccdf\_\-value\_\-new\_\-instance} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$val)
\item 
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_ga588a7943e055c76c4f0513fcc7aed7c1}{xccdf\_\-value\_\-get\_\-parent} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\begin{DoxyCompactList}\small\item\em Return value's parent in the grouping hierarchy. \item\end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__XCCDF_gaf437dcb9e59713b0a808ec1690b031fb}{xccdf\_\-value\_\-get\_\-version} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gad4b2c62132cd3b35bcedc38f3498fe7d}{xccdf\_\-value\_\-get\_\-question} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structxccdf__warning__iterator}{xccdf\_\-warning\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga1b15685c2b0bb6339fd11dda172581c0}{xccdf\_\-value\_\-get\_\-warnings} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
const char $\ast$ \hyperlink{group__XCCDF_gac4e50f1fbe4b67977e5ab2734128a0fc}{xccdf\_\-value\_\-get\_\-version\_\-update} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
time\_\-t \hyperlink{group__XCCDF_ga8cd21f2497214091aecf6d231ddeb73d}{xccdf\_\-value\_\-get\_\-version\_\-time} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_gacdf624d546368433220b44816d3535fa}{xccdf\_\-value\_\-get\_\-benchmark} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga6f3d5254e3b30ee39eb4300f32543132}{xccdf\_\-value\_\-get\_\-sources} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
const char $\ast$ \hyperlink{group__XCCDF_ga82e93431f4f2f606c5d0c254f63c60a6}{xccdf\_\-value\_\-get\_\-cluster\_\-id} (const struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item 
\hypertarget{group__XCCDF_gab36a6ccb8c75e54f43417b89ca9e26b6}{
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ {\bfseries xccdf\_\-group\_\-get\_\-parent} (const struct \hyperlink{structxccdf__group}{xccdf\_\-group} $\ast$group)}
\label{group__XCCDF_gab36a6ccb8c75e54f43417b89ca9e26b6}

\item 
\hypertarget{group__XCCDF_ga511cd8e0ed6e51032bc56bc362b90a03}{
const char $\ast$ \hyperlink{group__XCCDF_ga511cd8e0ed6e51032bc56bc362b90a03}{xccdf\_\-refine\_\-rule\_\-get\_\-item} (const struct \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} $\ast$rr)}
\label{group__XCCDF_ga511cd8e0ed6e51032bc56bc362b90a03}

\begin{DoxyCompactList}\small\item\em \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} \item\end{DoxyCompactList}\item 
\hypertarget{group__XCCDF_ga64cd41a4ede976b9568c50ec042b30e1}{
const char $\ast$ \hyperlink{group__XCCDF_ga64cd41a4ede976b9568c50ec042b30e1}{xccdf\_\-refine\_\-rule\_\-get\_\-selector} (const struct \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} $\ast$rr)}
\label{group__XCCDF_ga64cd41a4ede976b9568c50ec042b30e1}

\begin{DoxyCompactList}\small\item\em \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} \item\end{DoxyCompactList}\item 
\hypertarget{group__XCCDF_ga641a4bbe783ce30823bdf18f6de54ff2}{
\hyperlink{group__XCCDF_ga6cb5c6fdd0ccc42b1c8cec5313df5804}{xccdf\_\-role\_\-t} \hyperlink{group__XCCDF_ga641a4bbe783ce30823bdf18f6de54ff2}{xccdf\_\-refine\_\-rule\_\-get\_\-role} (const struct \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} $\ast$rr)}
\label{group__XCCDF_ga641a4bbe783ce30823bdf18f6de54ff2}

\begin{DoxyCompactList}\small\item\em \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} \item\end{DoxyCompactList}\item 
\hypertarget{group__XCCDF_ga2a121c6ab44f3ff4a18dd7dd246f7ac6}{
\hyperlink{group__XCCDF_ga209163661038a6be4066cdec716c997f}{xccdf\_\-level\_\-t} \hyperlink{group__XCCDF_ga2a121c6ab44f3ff4a18dd7dd246f7ac6}{xccdf\_\-refine\_\-rule\_\-get\_\-severity} (const struct \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} $\ast$rr)}
\label{group__XCCDF_ga2a121c6ab44f3ff4a18dd7dd246f7ac6}

\begin{DoxyCompactList}\small\item\em \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} \item\end{DoxyCompactList}\item 
\hypertarget{group__XCCDF_gad83b5f850f0b99332ec77b389b0f95b1}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gad83b5f850f0b99332ec77b389b0f95b1}{xccdf\_\-refine\_\-rule\_\-get\_\-remarks} (const struct \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} $\ast$rr)}
\label{group__XCCDF_gad83b5f850f0b99332ec77b389b0f95b1}

\begin{DoxyCompactList}\small\item\em \hyperlink{structxccdf__refine__rule}{xccdf\_\-refine\_\-rule} \item\end{DoxyCompactList}\item 
\hypertarget{group__XCCDF_gaa585b7495377cd592fa47dbdcf5b2ed8}{
const char $\ast$ {\bfseries xccdf\_\-refine\_\-value\_\-get\_\-item} (const struct \hyperlink{structxccdf__refine__value}{xccdf\_\-refine\_\-value} $\ast$rv)}
\label{group__XCCDF_gaa585b7495377cd592fa47dbdcf5b2ed8}

\end{DoxyCompactItemize}
\subsection*{Setters}
\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_gaf67d879da29f835e2c12c07725261ac1}{xccdf\_\-value\_\-set\_\-id} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, const char $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_gafba039ed03ac5f969ad3f3f566c6efe4}{xccdf\_\-value\_\-set\_\-cluster\_\-id} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, const char $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_gaecf5808fb8a695decf360499a261dfff}{xccdf\_\-value\_\-set\_\-extends} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, const char $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_ga603c033e7763eda18037959c490df193}{xccdf\_\-value\_\-set\_\-version} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, const char $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_ga4f268aba07585f769a98e39080bfd5bf}{xccdf\_\-value\_\-set\_\-version\_\-time} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, time\_\-t newval)
\item 
bool \hyperlink{group__XCCDF_ga42a5f346d4bf7cc5d55b4b54656dbbcf}{xccdf\_\-value\_\-set\_\-version\_\-update} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, const char $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_ga8f74b816aaa0aaba510de22e81ed1d49}{xccdf\_\-value\_\-set\_\-abstract} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, bool newval)
\item 
bool \hyperlink{group__XCCDF_gaa6d63fd858a966ae9ca0c44249a9331b}{xccdf\_\-value\_\-set\_\-hidden} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, bool newval)
\item 
bool \hyperlink{group__XCCDF_gac2a9a426810b3587d75d9e5296f614af}{xccdf\_\-value\_\-set\_\-multiple} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, bool newval)
\item 
bool \hyperlink{group__XCCDF_ga0afbabcf5d9189f7a5d8c6a8ac4bf8cb}{xccdf\_\-value\_\-set\_\-prohibit\_\-changes} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, bool newval)
\item 
bool \hyperlink{group__XCCDF_ga1d846c76d3023e6ebb2380ef9b73114a}{xccdf\_\-value\_\-set\_\-oper} (struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item, \hyperlink{group__XCCDF_ga4458b04cd1236b95d15ac2d74276c09c}{xccdf\_\-operator\_\-t} oper)
\item 
bool \hyperlink{group__XCCDF_ga6113b58faed1ea65a5f9035336a38ad0}{xccdf\_\-value\_\-add\_\-description} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_gac6dc39775105d370597feed29cb5ca88}{xccdf\_\-value\_\-add\_\-question} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_ga62ce2c72b1959d87a848b5cba436ab81}{xccdf\_\-value\_\-add\_\-reference} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structxccdf__reference}{xccdf\_\-reference} $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_gafa8116638559930eca36880d3fca185e}{xccdf\_\-value\_\-add\_\-status} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structxccdf__status}{xccdf\_\-status} $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_ga9baf970ff88bf11163a155696cfaf7fd}{xccdf\_\-value\_\-add\_\-title} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item 
bool \hyperlink{group__XCCDF_gad6b775a476ae6c7f26c87d8ce3de97ee}{xccdf\_\-value\_\-add\_\-warning} (struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$item, struct \hyperlink{structxccdf__warning}{xccdf\_\-warning} $\ast$newval)
\item 
\hypertarget{group__XCCDF_ga9a6ed3a7172d73709df974fad2502057}{
struct \hyperlink{structxccdf__setvalue}{xccdf\_\-setvalue} $\ast$ \hyperlink{group__XCCDF_ga9a6ed3a7172d73709df974fad2502057}{xccdf\_\-setvalue\_\-clone} (const struct \hyperlink{structxccdf__setvalue}{xccdf\_\-setvalue} $\ast$old\_\-value)}
\label{group__XCCDF_ga9a6ed3a7172d73709df974fad2502057}

\begin{DoxyCompactList}\small\item\em xccdf\_\-set\_\-value \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
XCCDF Value allows test parametrization or capturing output of tests. 

The documentation for this struct was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/XCCDF/public/\hyperlink{xccdf_8h}{xccdf.h}\end{DoxyCompactItemize}