File: structcpe__platform.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 (117 lines) | stat: -rw-r--r-- 7,318 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
\hypertarget{structcpe__platform}{
\section{cpe\_\-platform Struct Reference}
\label{structcpe__platform}\index{cpe\_\-platform@{cpe\_\-platform}}
}


Single platform representation in CPE language.  


{\ttfamily \#include $<$cpelang\_\-priv.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__cpelang_gad83641ba4fb292a923b7ff5753b4070d}{
struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$ \hyperlink{group__cpelang_gad83641ba4fb292a923b7ff5753b4070d}{cpe\_\-platform\_\-new} (void)}
\label{group__cpelang_gad83641ba4fb292a923b7ff5753b4070d}

\begin{DoxyCompactList}\small\item\em Constructor of CPE Platform. \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_ga1bcb12e96db31e6b57be749fd5ba3b3e}{
void \hyperlink{group__cpelang_ga1bcb12e96db31e6b57be749fd5ba3b3e}{cpe\_\-platform\_\-free} (struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform)}
\label{group__cpelang_ga1bcb12e96db31e6b57be749fd5ba3b3e}

\begin{DoxyCompactList}\small\item\em Free function of CPE Platform. \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__cpelang_ga8b9494431d8599fe802361433231436d}{
const char $\ast$ \hyperlink{group__cpelang_ga8b9494431d8599fe802361433231436d}{cpe\_\-platform\_\-get\_\-id} (const struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$item)}
\label{group__cpelang_ga8b9494431d8599fe802361433231436d}

\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__platform}{cpe\_\-platform} functions to get id \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_ga11161328967d030f8d71608b27415676}{
const char $\ast$ \hyperlink{group__cpelang_ga11161328967d030f8d71608b27415676}{cpe\_\-platform\_\-get\_\-remark} (const struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$item)}
\label{group__cpelang_ga11161328967d030f8d71608b27415676}

\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__platform}{cpe\_\-platform} functions to get remark \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_gab6a97be125225b1d698e7e6f9c0001f1}{
struct \hyperlink{structoscap__title__iterator}{oscap\_\-title\_\-iterator} $\ast$ \hyperlink{group__cpelang_gab6a97be125225b1d698e7e6f9c0001f1}{cpe\_\-platform\_\-get\_\-titles} (const struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$item)}
\label{group__cpelang_gab6a97be125225b1d698e7e6f9c0001f1}

\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__platform}{cpe\_\-platform} functions to get titles \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_ga66c92792dad71233eaca532a143aefac}{
struct \hyperlink{structcpe__testexpr}{cpe\_\-testexpr} $\ast$ \hyperlink{group__cpelang_ga66c92792dad71233eaca532a143aefac}{cpe\_\-platform\_\-get\_\-expr} (const struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$item)}
\label{group__cpelang_ga66c92792dad71233eaca532a143aefac}

\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__platform}{cpe\_\-platform} functions to get test expression \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
Get XML namespace from CPE lang model

For lists use add functions. Parameters of set functions are duplicated in memory and need to be freed by caller. }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__cpelang_ga64da424f8bd783da762bee8b766e247d}{
bool \hyperlink{group__cpelang_ga64da424f8bd783da762bee8b766e247d}{cpe\_\-platform\_\-add\_\-title} (struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform, struct \hyperlink{structoscap__title}{oscap\_\-title} $\ast$title)}
\label{group__cpelang_ga64da424f8bd783da762bee8b766e247d}

\begin{DoxyCompactList}\small\item\em Add title to platform. \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_gad59b55938ebbe388218016cb67fbac50}{
bool \hyperlink{group__cpelang_gad59b55938ebbe388218016cb67fbac50}{cpe\_\-platform\_\-set\_\-id} (struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform, const char $\ast$new\_\-id)}
\label{group__cpelang_gad59b55938ebbe388218016cb67fbac50}

\begin{DoxyCompactList}\small\item\em Set ID of CPE platform. \item\end{DoxyCompactList}\item 
\hypertarget{group__cpelang_ga301685568659041bd2a47c958800ddbc}{
bool \hyperlink{group__cpelang_ga301685568659041bd2a47c958800ddbc}{cpe\_\-platform\_\-set\_\-remark} (struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform, const char $\ast$new\_\-remark)}
\label{group__cpelang_ga301685568659041bd2a47c958800ddbc}

\begin{DoxyCompactList}\small\item\em Set remark of CPE platform. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__cpelang_gaa9bc76ff30e7f9faa4def792404c1a62}{cpe\_\-platform\_\-set\_\-expr} (struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform, struct \hyperlink{structcpe__testexpr}{cpe\_\-testexpr} $\ast$expr)
\begin{DoxyCompactList}\small\item\em Set evaluation expression for this CPE platform. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__cpelang_ga087bb45387925a51ae6be052320327c2}{cpe\_\-platform\_\-match\_\-cpe} (struct \hyperlink{structcpe__name}{cpe\_\-name} $\ast$$\ast$cpe, size\_\-t n, const struct \hyperlink{structcpe__platform}{cpe\_\-platform} $\ast$platform)
\begin{DoxyCompactList}\small\item\em Function to match cpe in platform. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structcpe__platform_a3b3b18d19e6e4f1b7b7be5211410154b}{
struct \hyperlink{structxml__metadata}{xml\_\-metadata} {\bfseries xml}}
\label{structcpe__platform_a3b3b18d19e6e4f1b7b7be5211410154b}

\item 
\hypertarget{structcpe__platform_aae91fa4786ad57827ff2e155123a9827}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries titles}}
\label{structcpe__platform_aae91fa4786ad57827ff2e155123a9827}

\item 
\hypertarget{structcpe__platform_ac81ce4c48ed2fe9b9a6a3a0bc30cbc8f}{
char $\ast$ {\bfseries id}}
\label{structcpe__platform_ac81ce4c48ed2fe9b9a6a3a0bc30cbc8f}

\item 
\hypertarget{structcpe__platform_a17cd31049cf21d4fef90fe1b83d4b07e}{
char $\ast$ {\bfseries remark}}
\label{structcpe__platform_a17cd31049cf21d4fef90fe1b83d4b07e}

\item 
\hypertarget{structcpe__platform_a0338e3ce90b9e10f9594b3e1cff0cee9}{
struct \hyperlink{structcpe__testexpr}{cpe\_\-testexpr} $\ast$ {\bfseries expr}}
\label{structcpe__platform_a0338e3ce90b9e10f9594b3e1cff0cee9}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Single platform representation in CPE language. 

The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/CPE/\hyperlink{cpelang__priv_8c}{cpelang\_\-priv.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/CPE/public/\hyperlink{cpelang_8h}{cpelang.h}\end{DoxyCompactItemize}