\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{Indent}{\bf Parse functions}\par
{\em \label{_amgrp55bde346b0631e090bfc4a3be713ee4c}
Functions for parsing structures from XML.
Return value is new structure filled by content of XML file represented by XML reader or import source structure. Structure needs to be freed by the caller. }\begin{DoxyCompactItemize}
\item
struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$ \hyperlink{group__CPEDictPrivate_gab330e1ce3e13aaf31edbe7d77f1530e5}{cpe\_\-dict\_\-model\_\-parse\_\-xml} (const struct \hyperlink{structoscap__import__source}{oscap\_\-import\_\-source} $\ast$source)
\begin{DoxyCompactList}\small\item\em Function to parse XML to CPE dictionary model. \item\end{DoxyCompactList}\item
struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$ \hyperlink{group__CPEDictPrivate_ga47dbcfc19a27100a459f3ef19d84418f}{cpe\_\-dict\_\-model\_\-parse} (xmlTextReaderPtr reader)
\begin{DoxyCompactList}\small\item\em Load new CPE dictionary from XML node. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Export functions}\par
{\em \label{_amgrp5713b34587ba18c5a4561b737b639ae5}
Functions for export structures to XML by XML writer.
Exported structures need to be freed by the caller. }\begin{DoxyCompactItemize}
\item
void \hyperlink{group__CPEDictPrivate_gaf69b63b2cded5f672bea7e93c730ac2b}{cpe\_\-dict\_\-model\_\-export\_\-xml} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict, const struct \hyperlink{structoscap__export__target}{oscap\_\-export\_\-target} $\ast$target)
\begin{DoxyCompactList}\small\item\em Export function for CPE dictionary model. \item\end{DoxyCompactList}\item
void \hyperlink{group__CPEDictPrivate_gaa67e4679e6c485673692d0807d0d0a99}{cpe\_\-dict\_\-export} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict, xmlTextWriterPtr writer)
\begin{DoxyCompactList}\small\item\em Internal export function for CPE dictionary model. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Get functions}\par
{\em \label{_amgrpc2ac1eb4de8ec5add5567cbae2f237e5}
Functions for getting attributes from CVE model structures.
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 Free functions}\par
{\em \label{_amgrp237dd65bc76b7de56066830910ced6ed}
Destructors of CVE model structures.
Functions free structures with all members recursively. For simple deletion of entity use remove functions. }\begin{DoxyCompactItemize}
\item
void \hyperlink{group__cpedict_ga8ba5fd300dbbff3350e27b9d5bd3c157}{cpe\_\-dict\_\-model\_\-free} (struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf New functions}\par
{\em \label{_amgrp73a4128f20867fa23ebb2e75e58922df}
Constructors of CVE model structures.
Free function returns new empty allocated structure. If returns non NULL it need to be freed by the caller. }\begin{DoxyCompactItemize}
\item
struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$ \hyperlink{group__cpedict_ga535f4d9ab9a4d63c2a8586d308b4066d}{cpe\_\-dict\_\-model\_\-new} (void)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Add functions}\par
{\em \label{_amgrpaabced06c8a2e8c15954ce4b1e334884}
Functions to add member to list.
Return value is true if added succesfuly or false in case of error. }\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 Other functions}\par
{\em \label{_amgrpb175402ebe89f00c62233c5453c5a243}
}\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
void \hyperlink{group__cpedict_ga5c58082a1bb06b72fc48ddf01bc965e5}{cpe\_\-dict\_\-model\_\-export} (const struct \hyperlink{structcpe__dict__model}{cpe\_\-dict\_\-model} $\ast$dict, const struct \hyperlink{structoscap__export__target}{oscap\_\-export\_\-target} $\ast$target)
\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_gae03243aeacaafbfcdd3a06cf8317a9d8}{cpe\_\-dict\_\-model\_\-import} (const struct \hyperlink{structoscap__import__source}{oscap\_\-import\_\-source} $\ast$source)
\begin{DoxyCompactList}\small\item\em Load new CPE dictionary from file. \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/openscap/openscap-\/0.5.7/src/CPE/\hyperlink{cpedict__priv_8c}{cpedict\_\-priv.c}\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/CPE/\hyperlink{cpedict__priv_8h}{cpedict\_\-priv.h}\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/CPE/public/\hyperlink{cpedict_8h}{cpedict.h}\end{DoxyCompactItemize}
