File: structcpe__dict__model.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 (98 lines) | stat: -rw-r--r-- 6,680 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
\hypertarget{structcpe__dict__model}{
\section{cpe\_\-dict\_\-model Struct Reference}
\label{structcpe__dict__model}\index{cpe\_\-dict\_\-model@{cpe\_\-dict\_\-model}}
}


Structure representing a CPE dictionary.  


{\ttfamily \#include $<$cpedict\_\-priv.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__cpedict_ga8ba5fd300dbbff3350e27b9d5bd3c157}{cpe\_\-dict\_\-model\_\-free} (struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict)
\item 
struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$ \hyperlink{group__cpedict_ga535f4d9ab9a4d63c2a8586d308b4066d}{cpe\_\-dict\_\-model\_\-new} (void)
\item 
void \hyperlink{group__cpedict_ga3dc08ad0483866473e5066869d5f542e}{cpe\_\-dict\_\-model\_\-export} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict, const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Write the dict\_\-model to a file. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$ \hyperlink{group__cpedict_ga0dc2738dea0113dad9a71740c216dbae}{cpe\_\-dict\_\-model\_\-import} (const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Load new CPE dictionary from file. \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 
struct \hyperlink{structcpe__item__iterator}{cpe\_\-item\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga206ed522a534a6e2c91ba919ac1b00b0}{cpe\_\-dict\_\-model\_\-get\_\-items} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} functions to get CPE items \item\end{DoxyCompactList}\item 
struct \hyperlink{structcpe__vendor__iterator}{cpe\_\-vendor\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga5e7d89457cd697fee063ba4ad41ff930}{cpe\_\-dict\_\-model\_\-get\_\-vendors} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} functions to get vendors \item\end{DoxyCompactList}\item 
\hypertarget{group__cpedict_ga7ddb03a5ffd1f967c722915f00d2e9c0}{
struct \hyperlink{structxml__metadata__iterator}{xml\_\-metadata\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga7ddb03a5ffd1f967c722915f00d2e9c0}{cpe\_\-dict\_\-model\_\-get\_\-xmlns} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$model)}
\label{group__cpedict_ga7ddb03a5ffd1f967c722915f00d2e9c0}

\begin{DoxyCompactList}\small\item\em Get XML namespace from CPE dict model. \item\end{DoxyCompactList}\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__cpedict_gac5c00a90ee125bc99e51abde05add610}{cpe\_\-dict\_\-model\_\-add\_\-vendor} (struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict, struct \hyperlink{structcpe__vendor}{cpe\_\-vendor} $\ast$new\_\-vendor)
\item 
\hypertarget{group__cpedict_gaeab13506267f399e19ea06ae98b127d4}{
bool \hyperlink{group__cpedict_gaeab13506267f399e19ea06ae98b127d4}{cpe\_\-dict\_\-model\_\-add\_\-xml} (struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$model, struct \hyperlink{structxml__metadata}{xml\_\-metadata} $\ast$xml)}
\label{group__cpedict_gaeab13506267f399e19ea06ae98b127d4}

\begin{DoxyCompactList}\small\item\em Add XML namespace to CPE dict model. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
const char $\ast$ \hyperlink{group__cpedict_ga8118960e36454c503a4681acfaba1e5e}{cpe\_\-dict\_\-model\_\-supported} (void)
\begin{DoxyCompactList}\small\item\em Get supported version of CPE dictionary XML. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__cpedict_ga521348e593c0caf8e2f82f0729dd997c}{cpe\_\-name\_\-match\_\-dict} (struct \hyperlink{structcpe__name}{cpe\_\-name} $\ast$cpe, struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict)
\begin{DoxyCompactList}\small\item\em Verify wether given CPE is known according to specified dictionary. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__cpedict_ga0bf19ab90612cb4af8931d83b51e59d6}{cpe\_\-name\_\-match\_\-dict\_\-str} (const char $\ast$cpe, struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict)
\begin{DoxyCompactList}\small\item\em Verify if CPE given by string is known according to specified dictionary. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structcpe__dict__model_ab432bc56eb9402a6e759810260f217f0}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries xmlns}}
\label{structcpe__dict__model_ab432bc56eb9402a6e759810260f217f0}

\item 
\hypertarget{structcpe__dict__model_afa2ceb8082159c49d83baa52a976203f}{
struct \hyperlink{structxml__metadata}{xml\_\-metadata} {\bfseries xml}}
\label{structcpe__dict__model_afa2ceb8082159c49d83baa52a976203f}

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

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

\item 
\hypertarget{structcpe__dict__model_a380baade2f244818b3b01fb54d14c441}{
struct \hyperlink{structcpe__generator}{cpe\_\-generator} $\ast$ {\bfseries generator}}
\label{structcpe__dict__model_a380baade2f244818b3b01fb54d14c441}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Structure representing a CPE dictionary. 

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{cpedict__priv_8c}{cpedict\_\-priv.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/CPE/public/\hyperlink{cpedict_8h}{cpedict.h}\end{DoxyCompactItemize}