\hypertarget{structoval__reference}{
\section{oval\_\-reference Struct Reference}
\label{structoval__reference}\index{oval\_\-reference@{oval\_\-reference}}
}


An Oval\_\-reference links an Oval\_\-definition to a definitive external reference.  


{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_gaa410bf73e8608575e7b2a7fcbe9bef8a}{
struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$ {\bfseries oval\_\-reference\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$)}
\label{group__OVALDEF_gaa410bf73e8608575e7b2a7fcbe9bef8a}

\item 
\hypertarget{group__OVALDEF_ga4f5d8b84579a886cbc41cbf1d056135a}{
struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$ {\bfseries oval\_\-reference\_\-clone} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$new\_\-model, struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$old\_\-reference)}
\label{group__OVALDEF_ga4f5d8b84579a886cbc41cbf1d056135a}

\item 
\hypertarget{group__OVALDEF_ga4407eaefc688ce822d9038765ffd400b}{
void {\bfseries oval\_\-reference\_\-free} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$)}
\label{group__OVALDEF_ga4407eaefc688ce822d9038765ffd400b}

\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_gadbe51ecd95ea885ed7d4333d6a91bbf1}{
void \hyperlink{group__OVALDEF_gadbe51ecd95ea885ed7d4333d6a91bbf1}{oval\_\-reference\_\-set\_\-source} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$, char $\ast$)}
\label{group__OVALDEF_gadbe51ecd95ea885ed7d4333d6a91bbf1}

\begin{DoxyCompactList}\small\item\em Set OVAL reference source. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_gaa2ece3adf7082800549c2ead731ddae7}{
void {\bfseries oval\_\-reference\_\-set\_\-id} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$, char $\ast$)}
\label{group__OVALDEF_gaa2ece3adf7082800549c2ead731ddae7}

\item 
\hypertarget{group__OVALDEF_ga8e62130ab7edada5b4e32b28c3daf54b}{
void {\bfseries oval\_\-reference\_\-set\_\-url} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$, char $\ast$)}
\label{group__OVALDEF_ga8e62130ab7edada5b4e32b28c3daf54b}

\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_ga0dd9435c7e89f26df629b1db9a5b6d4f}{
char $\ast$ \hyperlink{group__OVALDEF_ga0dd9435c7e89f26df629b1db9a5b6d4f}{oval\_\-reference\_\-get\_\-source} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$)}
\label{group__OVALDEF_ga0dd9435c7e89f26df629b1db9a5b6d4f}

\begin{DoxyCompactList}\small\item\em Get OVAL reference source. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga0156cabd1801258ef518c8d864c42bd9}{
char $\ast$ \hyperlink{group__OVALDEF_ga0156cabd1801258ef518c8d864c42bd9}{oval\_\-reference\_\-get\_\-id} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$)}
\label{group__OVALDEF_ga0156cabd1801258ef518c8d864c42bd9}

\begin{DoxyCompactList}\small\item\em Get OVAL reference ID. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga8ac0f7c3786be23fbb630903b05cd87c}{
char $\ast$ \hyperlink{group__OVALDEF_ga8ac0f7c3786be23fbb630903b05cd87c}{oval\_\-reference\_\-get\_\-url} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$)}
\label{group__OVALDEF_ga8ac0f7c3786be23fbb630903b05cd87c}

\begin{DoxyCompactList}\small\item\em Get OVAL reference URL. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__OVALDEF_gaff798c08a2de5bc62bfe116052079b45}{oval\_\-reference\_\-is\_\-locked} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$reference)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the reference instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_ga67a01afbd1b2b59bc0d2cbd72074bd1c}{
bool \hyperlink{group__OVALDEF_ga67a01afbd1b2b59bc0d2cbd72074bd1c}{oval\_\-reference\_\-is\_\-valid} (struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$reference)}
\label{group__OVALDEF_ga67a01afbd1b2b59bc0d2cbd72074bd1c}

\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the reference instance is valid \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoval__reference_a891d720e550e86c3593a4dc1a16a3de5}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__reference_a891d720e550e86c3593a4dc1a16a3de5}

\item 
\hypertarget{structoval__reference_a37cacabd7c1f267acdc39991814d26a3}{
char $\ast$ {\bfseries source}}
\label{structoval__reference_a37cacabd7c1f267acdc39991814d26a3}

\item 
\hypertarget{structoval__reference_a2d1a6b685af6deb26f1f6f473412d793}{
char $\ast$ {\bfseries id}}
\label{structoval__reference_a2d1a6b685af6deb26f1f6f473412d793}

\item 
\hypertarget{structoval__reference_a08ab253890fef2c24eca9ba2425a002f}{
char $\ast$ {\bfseries url}}
\label{structoval__reference_a08ab253890fef2c24eca9ba2425a002f}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
An Oval\_\-reference links an Oval\_\-definition to a definitive external reference. For example, CVE Identifiers for vulnerabilities. The intended purpose for this reference is to link the definition to a variety of other sources that address the same issue being specified by the Oval\_\-definition. 

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__reference_8c}{oval\_\-reference.c}\item 
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/public/\hyperlink{oval__definitions_8h}{oval\_\-definitions.h}\end{DoxyCompactItemize}