\hypertarget{structoval__variable__model}{
\section{oval\_\-variable\_\-model Struct Reference}
\label{structoval__variable__model}\index{oval\_\-variable\_\-model@{oval\_\-variable\_\-model}}
}
The OVAL variable model facilitates access to external variable value bindings used to to constrain the evaluation of OVAL objects.
{\ttfamily \#include $<$oval\_\-types.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
int \hyperlink{group__OVALVAR_ga275b0d836afc5e6b590744b74c918678}{oval\_\-variable\_\-model\_\-import} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$, struct \hyperlink{structoscap__import__source}{oscap\_\-import\_\-source} $\ast$, void $\ast$)
\begin{DoxyCompactList}\small\item\em Load the specified \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} from an XML stream. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALVAR_gabaafcd4d6b01dd453467648be6af9ef1}{
struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$ \hyperlink{group__OVALVAR_gabaafcd4d6b01dd453467648be6af9ef1}{oval\_\-variable\_\-model\_\-new} (void)}
\label{group__OVALVAR_gabaafcd4d6b01dd453467648be6af9ef1}
\begin{DoxyCompactList}\small\item\em Create a new OVAL variable model. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALVAR_gae1c4184092de65edfe1424ad1759dd23}{
struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$ \hyperlink{group__OVALVAR_gae1c4184092de65edfe1424ad1759dd23}{oval\_\-variable\_\-model\_\-clone} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$)}
\label{group__OVALVAR_gae1c4184092de65edfe1424ad1759dd23}
\begin{DoxyCompactList}\small\item\em Clone an OVAL variable model. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALVAR_ga365f33d97173121f2ad7ccfccf336843}{oval\_\-variable\_\-model\_\-free} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$)
\begin{DoxyCompactList}\small\item\em Free memory allocated to a specified \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model}. \item\end{DoxyCompactList}\item
int \hyperlink{group__OVALVAR_gafc39c319dc4ed43ab55b362bcdc19ce8}{oval\_\-variable\_\-model\_\-export} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$, struct \hyperlink{structoscap__export__target}{oscap\_\-export\_\-target} $\ast$)
\begin{DoxyCompactList}\small\item\em Export the specified \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} to an XML stream. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
}\begin{DoxyCompactItemize}
\item
void \hyperlink{group__OVALVAR_ga85e31b556710186bd3ee73af8005fc2b}{oval\_\-variable\_\-model\_\-lock} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$variable\_\-model)
\begin{DoxyCompactList}\small\item\em Lock the variable\_\-model instance. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALVAR_ga462a5716ee28a72b8f053b188507551b}{oval\_\-variable\_\-model\_\-add} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$model, char $\ast$varid, const char $\ast$comment, \hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} datatype, char $\ast$value)
\begin{DoxyCompactList}\small\item\em Get the values bound to a specified external variable. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
}\begin{DoxyCompactItemize}
\item
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALVAR_ga1dbc23e41fad2352ee9ac24578258bdf}{oval\_\-variable\_\-model\_\-get\_\-variable\_\-ids} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$)
\begin{DoxyCompactList}\small\item\em Get all external variables managed by a specified \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model}. \item\end{DoxyCompactList}\item
\hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} \hyperlink{group__OVALVAR_gaf4a30ae55879ddf17627934f4fde1c9b}{oval\_\-variable\_\-model\_\-get\_\-datatype} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$, char $\ast$)
\begin{DoxyCompactList}\small\item\em Get a specified external variable datatype. \item\end{DoxyCompactList}\item
const char $\ast$ \hyperlink{group__OVALVAR_ga4b189de3fb06eb07c756d44e56ecd096}{oval\_\-variable\_\-model\_\-get\_\-comment} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$, char $\ast$)
\begin{DoxyCompactList}\small\item\em Get a specified external variable comment. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALVAR_ga2e52fe832f3cf5c63d4d6890472e85c8}{oval\_\-variable\_\-model\_\-get\_\-values} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$, char $\ast$)
\begin{DoxyCompactList}\small\item\em Get the values bound to a specified external variable. \item\end{DoxyCompactList}\item
bool \hyperlink{group__OVALVAR_ga021f29cdfde3e07d67953eef473f5565}{oval\_\-variable\_\-model\_\-is\_\-locked} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$variable\_\-model)
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the variable\_\-model instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALVAR_gaf6bb2f236105616566abc218b91901c3}{
bool \hyperlink{group__OVALVAR_gaf6bb2f236105616566abc218b91901c3}{oval\_\-variable\_\-model\_\-is\_\-valid} (struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$variable\_\-model)}
\label{group__OVALVAR_gaf6bb2f236105616566abc218b91901c3}
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the variable\_\-model instance is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structoval__variable__model_addd793a8ef14fe2f5733de0745c969f3}{
struct \hyperlink{structoval__string__map}{oval\_\-string\_\-map} $\ast$ {\bfseries varmap}}
\label{structoval__variable__model_addd793a8ef14fe2f5733de0745c969f3}
\item
\hypertarget{structoval__variable__model_a7715eba7eb68c0bc2a2bb8913a11a3b4}{
bool {\bfseries is\_\-locked}}
\label{structoval__variable__model_a7715eba7eb68c0bc2a2bb8913a11a3b4}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
The OVAL variable model facilitates access to external variable value bindings used to to constrain the evaluation of OVAL objects.
The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/\hyperlink{oval__varModel_8c}{oval\_\-varModel.c}\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/public/\hyperlink{oval__variables_8h}{oval\_\-variables.h}\end{DoxyCompactItemize}
