\hypertarget{structcpe__item}{
\section{cpe\_\-item Struct Reference}
\label{structcpe__item}\index{cpe\_\-item@{cpe\_\-item}}
}
Structure representing single CPE dictionary item.
{\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__item}{cpe\_\-item} $\ast$ \hyperlink{group__CPEDictPrivate_ga9b4c6eb4f498f12ace9be653252ff9ef}{cpe\_\-item\_\-parse} (xmlTextReaderPtr reader)
\begin{DoxyCompactList}\small\item\em New dictionary item from XML. \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_gadb776a9e1ba4acd6ed5761da44fe667b}{cpe\_\-item\_\-export} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, xmlTextWriterPtr writer)
\begin{DoxyCompactList}\small\item\em Exporting function for CPE item. \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__name}{cpe\_\-name} $\ast$ \hyperlink{group__cpedict_ga2e61427852c3a13926fb0fc1494e2999}{cpe\_\-item\_\-get\_\-name} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get variable member name \item\end{DoxyCompactList}\item
struct \hyperlink{structcpe__name}{cpe\_\-name} $\ast$ \hyperlink{group__cpedict_gaa1a0b946da4f28874dfd062373737bd2}{cpe\_\-item\_\-get\_\-deprecated} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get variable member deprecated \item\end{DoxyCompactList}\item
const char $\ast$ \hyperlink{group__cpedict_ga49a4fb0b0841368bebd79405240a3bf4}{cpe\_\-item\_\-get\_\-deprecation\_\-date} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get variable member date \item\end{DoxyCompactList}\item
struct \hyperlink{structcpe__item__metadata}{cpe\_\-item\_\-metadata} $\ast$ \hyperlink{group__cpedict_gad619090ae9166f487643159b0d21b2d8}{cpe\_\-item\_\-get\_\-metadata} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get metadata of \hyperlink{structcpe__item}{cpe\_\-item} \item\end{DoxyCompactList}\item
struct \hyperlink{structcpe__reference__iterator}{cpe\_\-reference\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga0ba8f555bf9436af38605800b47d9d02}{cpe\_\-item\_\-get\_\-references} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get CPE references \item\end{DoxyCompactList}\item
struct \hyperlink{structcpe__check__iterator}{cpe\_\-check\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga76ca0c433155cc326af4439004753e50}{cpe\_\-item\_\-get\_\-checks} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get CPE checks \item\end{DoxyCompactList}\item
struct \hyperlink{structoscap__title__iterator}{oscap\_\-title\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga380127ff98df3c779a78834275834526}{cpe\_\-item\_\-get\_\-titles} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get CPE titles \item\end{DoxyCompactList}\item
struct \hyperlink{structoscap__title__iterator}{oscap\_\-title\_\-iterator} $\ast$ \hyperlink{group__cpedict_ga322fae4538ca874173f294a16605a3d7}{cpe\_\-item\_\-get\_\-notes} (const struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\begin{DoxyCompactList}\small\item\em \hyperlink{structcpe__item}{cpe\_\-item} functions to get CPE notes \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_ga1107849fc84c83ee923092a91d9cab04}{cpe\_\-item\_\-free} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item)
\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__item}{cpe\_\-item} $\ast$ \hyperlink{group__cpedict_ga2bb69fddb8a6bb464d032b0c3271e499}{cpe\_\-item\_\-new} (void)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Set functions}\par
{\em \label{_amgrp8b7ecf2f4bd25da1aae981677901d55d}
Set functions assign values to members of structures except lists.
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_ga42805776141de4fbc16ec3c27a689cd5}{cpe\_\-item\_\-set\_\-deprecation\_\-date} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, const char $\ast$new\_\-deprecation\_\-date)
\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_ga34beb8ded8a6266e9c7d753467e316f2}{cpe\_\-item\_\-add\_\-reference} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, struct \hyperlink{structcpe__reference}{cpe\_\-reference} $\ast$new\_\-reference)
\item
bool \hyperlink{group__cpedict_gad5964c784858955efbd6b447f02fea98}{cpe\_\-item\_\-add\_\-check} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, struct \hyperlink{structcpe__check}{cpe\_\-check} $\ast$new\_\-check)
\item
bool \hyperlink{group__cpedict_ga543f8b8fc3fbcfb748c8ee41e4fc0c52}{cpe\_\-item\_\-add\_\-title} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, struct \hyperlink{structoscap__title}{oscap\_\-title} $\ast$new\_\-title)
\item
bool \hyperlink{group__cpedict_gaad43a0508d8d36f71bfd18fbcb45edac}{cpe\_\-item\_\-add\_\-note} (struct \hyperlink{structcpe__item}{cpe\_\-item} $\ast$item, struct \hyperlink{structoscap__title}{oscap\_\-title} $\ast$new\_\-title)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Remove functions}\par
{\em \label{_amgrp40428a142bd2c0b6ea1306c0905502ce}
Functions removing member elements from CPE data structures. }\begin{DoxyCompactItemize}
\item
void \hyperlink{group__cpedict_ga3a0cb59d7dd59f674c37348e52ed4945}{cpe\_\-item\_\-iterator\_\-remove} (struct \hyperlink{structcpe__item__iterator}{cpe\_\-item\_\-iterator} $\ast$it)
\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structcpe__item_a9b015dfca6ce2ac8551d17da5f274f7b}{
struct \hyperlink{structxml__metadata}{xml\_\-metadata} {\bfseries xml}}
\label{structcpe__item_a9b015dfca6ce2ac8551d17da5f274f7b}
\item
\hypertarget{structcpe__item_aa9877c425c462e810ba68e8333288e72}{
struct \hyperlink{structcpe__name}{cpe\_\-name} $\ast$ {\bfseries name}}
\label{structcpe__item_aa9877c425c462e810ba68e8333288e72}
\item
\hypertarget{structcpe__item_a46682f7586b287ec2a6f695e2ffa499e}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries titles}}
\label{structcpe__item_a46682f7586b287ec2a6f695e2ffa499e}
\item
\hypertarget{structcpe__item_a3dae13d8fc9ee810ae3210172ede1c26}{
struct \hyperlink{structcpe__name}{cpe\_\-name} $\ast$ {\bfseries deprecated}}
\label{structcpe__item_a3dae13d8fc9ee810ae3210172ede1c26}
\item
\hypertarget{structcpe__item_acbdd49d44665cb2fb804a8ee6ae11265}{
char $\ast$ {\bfseries deprecation\_\-date}}
\label{structcpe__item_acbdd49d44665cb2fb804a8ee6ae11265}
\item
\hypertarget{structcpe__item_ad7da772db6d2d547a5d26109e95d5c04}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries references}}
\label{structcpe__item_ad7da772db6d2d547a5d26109e95d5c04}
\item
\hypertarget{structcpe__item_ae0521c40b55a099ffa874490429b7cc9}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries checks}}
\label{structcpe__item_ae0521c40b55a099ffa874490429b7cc9}
\item
\hypertarget{structcpe__item_a6985cd6f755af85215581e84780d494a}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries notes}}
\label{structcpe__item_a6985cd6f755af85215581e84780d494a}
\item
\hypertarget{structcpe__item_ab10af0515c684a4934303de5736e96a0}{
struct \hyperlink{structcpe__item__metadata}{cpe\_\-item\_\-metadata} $\ast$ {\bfseries metadata}}
\label{structcpe__item_ab10af0515c684a4934303de5736e96a0}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Structure representing single CPE dictionary item.
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}
