Sophie

Sophie

distrib > Mandriva > current > x86_64 > by-pkgid > 3736f276bb1ccfbcee6cb2d27b25d981 > files > 598

openscap-devel-0.5.7-1mdv2010.1.x86_64.rpm

\hypertarget{group__CCE}{
\section{CCE}
\label{group__CCE}\index{CCE@{CCE}}
}
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structcce}{cce}
\begin{DoxyCompactList}\small\item\em Structure holding CCE entries. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__entry}{cce\_\-entry}
\begin{DoxyCompactList}\small\item\em Structure holding single CCE entry data. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__reference}{cce\_\-reference}
\begin{DoxyCompactList}\small\item\em Structure holding a CCE reference. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__reference__iterator}{cce\_\-reference\_\-iterator}
\begin{DoxyCompactList}\small\item\em Iterator over CCE references. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__entry__iterator}{cce\_\-entry\_\-iterator}
\begin{DoxyCompactList}\small\item\em Iterator over CCE entries. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Files}
\begin{DoxyCompactItemize}
\item 
file \hyperlink{cce_8h}{cce.h}


\begin{DoxyCompactList}\small\item\em Interface to Common Configuration Enumeration (CCE). \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__CCE_ga0ef192211b0ba7e19328920fc5a7cae1}{cce\_\-validate} (const char $\ast$filename)
\begin{DoxyCompactList}\small\item\em Vlaidate CCE XML file. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__reference}{cce\_\-reference} $\ast$ \hyperlink{group__CCE_ga62bff9cae373da442e5eef19e0c54fc9}{cce\_\-reference\_\-iterator::cce\_\-reference\_\-iterator\_\-next} (struct \hyperlink{structcce__reference__iterator}{cce\_\-reference\_\-iterator} $\ast$it)
\item 
bool \hyperlink{group__CCE_gaab76256cfe8b8bdbb998a177487ecb62}{cce\_\-reference\_\-iterator::cce\_\-reference\_\-iterator\_\-has\_\-more} (struct \hyperlink{structcce__reference__iterator}{cce\_\-reference\_\-iterator} $\ast$it)
\item 
void \hyperlink{group__CCE_ga2625080872bec0ea12f2ace6a32cee89}{cce\_\-reference\_\-iterator::cce\_\-reference\_\-iterator\_\-free} (struct \hyperlink{structcce__reference__iterator}{cce\_\-reference\_\-iterator} $\ast$it)
\item 
struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$ \hyperlink{group__CCE_gadef987b5c37644c4c0abddf1afb21b82}{cce\_\-entry\_\-iterator::cce\_\-entry\_\-iterator\_\-next} (struct \hyperlink{structcce__entry__iterator}{cce\_\-entry\_\-iterator} $\ast$it)
\item 
bool \hyperlink{group__CCE_gad1801fa9c1492a5090fe9d086c1ea963}{cce\_\-entry\_\-iterator::cce\_\-entry\_\-iterator\_\-has\_\-more} (struct \hyperlink{structcce__entry__iterator}{cce\_\-entry\_\-iterator} $\ast$it)
\item 
void \hyperlink{group__CCE_ga60f687d0a6df957a66ca645e9e06f19e}{cce\_\-entry\_\-iterator::cce\_\-entry\_\-iterator\_\-free} (struct \hyperlink{structcce__entry__iterator}{cce\_\-entry\_\-iterator} $\ast$it)
\item 
struct \hyperlink{structcce}{cce} $\ast$ \hyperlink{group__CCE_gaaffe83cc955e2b2e09beb26f178d92c0}{cce::cce\_\-new} (const char $\ast$fname)
\begin{DoxyCompactList}\small\item\em Create a new CCE structure from XML file. \item\end{DoxyCompactList}\item 
void \hyperlink{group__CCE_gaf276ebae2890323a8820c6d28f55f5b3}{cce::cce\_\-free} (struct \hyperlink{structcce}{cce} $\ast$\hyperlink{structcce}{cce})
\begin{DoxyCompactList}\small\item\em CCE structure destructor. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_ga66a95018e115b837e91361e2e51746fc}{
struct \hyperlink{structcce__entry__iterator}{cce\_\-entry\_\-iterator} $\ast$ \hyperlink{group__CCE_ga66a95018e115b837e91361e2e51746fc}{cce::cce\_\-get\_\-entries} (const struct \hyperlink{structcce}{cce} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_ga66a95018e115b837e91361e2e51746fc}

\begin{DoxyCompactList}\small\item\em Get an iterator to the contents of the CCE. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$ \hyperlink{group__CCE_ga4ee2017074b9d3cecacb4f7c665302a9}{cce::cce\_\-get\_\-entry} (const struct \hyperlink{structcce}{cce} $\ast$\hyperlink{structcce}{cce}, const char $\ast$id)
\begin{DoxyCompactList}\small\item\em Get an CCE entry by ID. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_ga283ab5c803313d976c8c7c9676de0f02}{
const char $\ast$ \hyperlink{group__CCE_ga283ab5c803313d976c8c7c9676de0f02}{cce\_\-entry::cce\_\-entry\_\-get\_\-id} (const struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_ga283ab5c803313d976c8c7c9676de0f02}

\begin{DoxyCompactList}\small\item\em Get CCE entry ID. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_gabf6f975c9137420a95f8eb1f47169587}{
const char $\ast$ \hyperlink{group__CCE_gabf6f975c9137420a95f8eb1f47169587}{cce\_\-entry::cce\_\-entry\_\-get\_\-description} (const struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_gabf6f975c9137420a95f8eb1f47169587}

\begin{DoxyCompactList}\small\item\em Get CCE entry desription. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_ga39fac44a0f669ac2dad57719e93a3988}{
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ \hyperlink{group__CCE_ga39fac44a0f669ac2dad57719e93a3988}{cce\_\-entry::cce\_\-entry\_\-get\_\-params} (const struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_ga39fac44a0f669ac2dad57719e93a3988}

\begin{DoxyCompactList}\small\item\em Get an iterator to CCE entry's parameters. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_gafd403dfc778e139e38b334b1f5396b1e}{
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ \hyperlink{group__CCE_gafd403dfc778e139e38b334b1f5396b1e}{cce\_\-entry::cce\_\-entry\_\-get\_\-tech\_\-mechs} (const struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_gafd403dfc778e139e38b334b1f5396b1e}

\begin{DoxyCompactList}\small\item\em Get an iterator to CCE entry's technical mechanisms. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_ga9191a1c0f3dbd61e5186757881420152}{
struct \hyperlink{structcce__reference__iterator}{cce\_\-reference\_\-iterator} $\ast$ \hyperlink{group__CCE_ga9191a1c0f3dbd61e5186757881420152}{cce\_\-entry::cce\_\-entry\_\-get\_\-references} (const struct \hyperlink{structcce__entry}{cce\_\-entry} $\ast$\hyperlink{structcce}{cce})}
\label{group__CCE_ga9191a1c0f3dbd61e5186757881420152}

\begin{DoxyCompactList}\small\item\em Get an iterator to CCE entry's references. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_ga833b5414e28e8d0c90ae44217ddbd4ee}{
const char $\ast$ \hyperlink{group__CCE_ga833b5414e28e8d0c90ae44217ddbd4ee}{cce\_\-reference::cce\_\-reference\_\-get\_\-source} (const struct \hyperlink{structcce__reference}{cce\_\-reference} $\ast$ref)}
\label{group__CCE_ga833b5414e28e8d0c90ae44217ddbd4ee}

\begin{DoxyCompactList}\small\item\em Get source of CCE reference. \item\end{DoxyCompactList}\item 
\hypertarget{group__CCE_gaa86502b7deca12a4a5683bc962e563da}{
const char $\ast$ \hyperlink{group__CCE_gaa86502b7deca12a4a5683bc962e563da}{cce\_\-reference::cce\_\-reference\_\-get\_\-value} (const struct \hyperlink{structcce__reference}{cce\_\-reference} $\ast$ref)}
\label{group__CCE_gaa86502b7deca12a4a5683bc962e563da}

\begin{DoxyCompactList}\small\item\em Get contents of CCE reference. \item\end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__CCE_gaea9ebc3534f768c0b4bd43177c0610ff}{cce::cce\_\-supported} (void)
\begin{DoxyCompactList}\small\item\em Get supported version of CCE XML. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Function Documentation}
\hypertarget{group__CCE_ga60f687d0a6df957a66ca645e9e06f19e}{
\index{CCE@{CCE}!cce\_\-entry\_\-iterator\_\-free@{cce\_\-entry\_\-iterator\_\-free}}
\index{cce\_\-entry\_\-iterator\_\-free@{cce\_\-entry\_\-iterator\_\-free}!CCE@{CCE}}
\subsubsection[{cce\_\-entry\_\-iterator\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void cce\_\-entry\_\-iterator\_\-free (struct {\bf cce\_\-entry\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_ga60f687d0a6df957a66ca645e9e06f19e}
\hypertarget{group__CCE_gad1801fa9c1492a5090fe9d086c1ea963}{
\index{CCE@{CCE}!cce\_\-entry\_\-iterator\_\-has\_\-more@{cce\_\-entry\_\-iterator\_\-has\_\-more}}
\index{cce\_\-entry\_\-iterator\_\-has\_\-more@{cce\_\-entry\_\-iterator\_\-has\_\-more}!CCE@{CCE}}
\subsubsection[{cce\_\-entry\_\-iterator\_\-has\_\-more}]{\setlength{\rightskip}{0pt plus 5cm}bool cce\_\-entry\_\-iterator\_\-has\_\-more (struct {\bf cce\_\-entry\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gad1801fa9c1492a5090fe9d086c1ea963}
\hypertarget{group__CCE_gadef987b5c37644c4c0abddf1afb21b82}{
\index{CCE@{CCE}!cce\_\-entry\_\-iterator\_\-next@{cce\_\-entry\_\-iterator\_\-next}}
\index{cce\_\-entry\_\-iterator\_\-next@{cce\_\-entry\_\-iterator\_\-next}!CCE@{CCE}}
\subsubsection[{cce\_\-entry\_\-iterator\_\-next}]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf cce\_\-entry} $\ast$ cce\_\-entry\_\-iterator\_\-next (struct {\bf cce\_\-entry\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gadef987b5c37644c4c0abddf1afb21b82}
\hypertarget{group__CCE_gaf276ebae2890323a8820c6d28f55f5b3}{
\index{CCE@{CCE}!cce\_\-free@{cce\_\-free}}
\index{cce\_\-free@{cce\_\-free}!CCE@{CCE}}
\subsubsection[{cce\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void cce\_\-free (struct {\bf cce} $\ast$ {\em cce})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gaf276ebae2890323a8820c6d28f55f5b3}


CCE structure destructor. Deinitializes CCE structure and releases used resources.


\begin{DoxyParams}{Parameters}
\item[{\em \hyperlink{structcce}{cce}}]pointer to target structure \end{DoxyParams}
\hypertarget{group__CCE_ga4ee2017074b9d3cecacb4f7c665302a9}{
\index{CCE@{CCE}!cce\_\-get\_\-entry@{cce\_\-get\_\-entry}}
\index{cce\_\-get\_\-entry@{cce\_\-get\_\-entry}!CCE@{CCE}}
\subsubsection[{cce\_\-get\_\-entry}]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf cce\_\-entry} $\ast$ cce\_\-get\_\-entry (const struct {\bf cce} $\ast$ {\em cce}, \/  const char $\ast$ {\em id})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_ga4ee2017074b9d3cecacb4f7c665302a9}


Get an CCE entry by ID. 
\begin{DoxyRetVals}{Return values}
\item[{\em NULL}]if given entry does not exist \end{DoxyRetVals}
\hypertarget{group__CCE_gaaffe83cc955e2b2e09beb26f178d92c0}{
\index{CCE@{CCE}!cce\_\-new@{cce\_\-new}}
\index{cce\_\-new@{cce\_\-new}!CCE@{CCE}}
\subsubsection[{cce\_\-new}]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf cce} $\ast$ cce\_\-new (const char $\ast$ {\em fname})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gaaffe83cc955e2b2e09beb26f178d92c0}


Create a new CCE structure from XML file. 
\begin{DoxyParams}{Parameters}
\item[{\em fname}]XML file name to porcess \end{DoxyParams}

\begin{DoxyRetVals}{Return values}
\item[{\em NULL}]on failure \end{DoxyRetVals}
\hypertarget{group__CCE_ga2625080872bec0ea12f2ace6a32cee89}{
\index{CCE@{CCE}!cce\_\-reference\_\-iterator\_\-free@{cce\_\-reference\_\-iterator\_\-free}}
\index{cce\_\-reference\_\-iterator\_\-free@{cce\_\-reference\_\-iterator\_\-free}!CCE@{CCE}}
\subsubsection[{cce\_\-reference\_\-iterator\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void cce\_\-reference\_\-iterator\_\-free (struct {\bf cce\_\-reference\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_ga2625080872bec0ea12f2ace6a32cee89}
\hypertarget{group__CCE_gaab76256cfe8b8bdbb998a177487ecb62}{
\index{CCE@{CCE}!cce\_\-reference\_\-iterator\_\-has\_\-more@{cce\_\-reference\_\-iterator\_\-has\_\-more}}
\index{cce\_\-reference\_\-iterator\_\-has\_\-more@{cce\_\-reference\_\-iterator\_\-has\_\-more}!CCE@{CCE}}
\subsubsection[{cce\_\-reference\_\-iterator\_\-has\_\-more}]{\setlength{\rightskip}{0pt plus 5cm}bool cce\_\-reference\_\-iterator\_\-has\_\-more (struct {\bf cce\_\-reference\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gaab76256cfe8b8bdbb998a177487ecb62}
\hypertarget{group__CCE_ga62bff9cae373da442e5eef19e0c54fc9}{
\index{CCE@{CCE}!cce\_\-reference\_\-iterator\_\-next@{cce\_\-reference\_\-iterator\_\-next}}
\index{cce\_\-reference\_\-iterator\_\-next@{cce\_\-reference\_\-iterator\_\-next}!CCE@{CCE}}
\subsubsection[{cce\_\-reference\_\-iterator\_\-next}]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf cce\_\-reference} $\ast$ cce\_\-reference\_\-iterator\_\-next (struct {\bf cce\_\-reference\_\-iterator} $\ast$ {\em it})\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_ga62bff9cae373da442e5eef19e0c54fc9}
\hypertarget{group__CCE_gaea9ebc3534f768c0b4bd43177c0610ff}{
\index{CCE@{CCE}!cce\_\-supported@{cce\_\-supported}}
\index{cce\_\-supported@{cce\_\-supported}!CCE@{CCE}}
\subsubsection[{cce\_\-supported}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ cce\_\-supported (void)\hspace{0.3cm}{\ttfamily  \mbox{[}related, inherited\mbox{]}}}}
\label{group__CCE_gaea9ebc3534f768c0b4bd43177c0610ff}


Get supported version of CCE XML. \begin{DoxyReturn}{Returns}
version of XML file format 
\end{DoxyReturn}
\hypertarget{group__CCE_ga0ef192211b0ba7e19328920fc5a7cae1}{
\index{CCE@{CCE}!cce\_\-validate@{cce\_\-validate}}
\index{cce\_\-validate@{cce\_\-validate}!CCE@{CCE}}
\subsubsection[{cce\_\-validate}]{\setlength{\rightskip}{0pt plus 5cm}bool cce\_\-validate (const char $\ast$ {\em filename})}}
\label{group__CCE_ga0ef192211b0ba7e19328920fc5a7cae1}


Vlaidate CCE XML file. 
\begin{DoxyParams}{Parameters}
\item[{\em filename}]file to be validated \end{DoxyParams}
\begin{DoxyReturn}{Returns}
result of validation (true / false) 
\end{DoxyReturn}