Sophie

Sophie

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

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

\hypertarget{structoval__test}{
\section{oval\_\-test Struct Reference}
\label{structoval__test}\index{oval\_\-test@{oval\_\-test}}
}


An Oval\_\-test specifies a technical control by identifying an \hyperlink{structoval__object}{oval\_\-object} that is evaluated on an instrumented host platform and, optionally, an Oval\_\-state instance that matches the object query.  


{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoval__test}{oval\_\-test} $\ast$ \hyperlink{group__OVALDEF_ga107bf8171067fe306450bd61449afa93}{oval\_\-test\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$, char $\ast$id)
\begin{DoxyCompactList}\small\item\em Construct new instance of \hyperlink{structoval__test}{oval\_\-test}. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_gae5e54ab1d82a1bd0f7adb6fab2e73ffd}{
void \hyperlink{group__OVALDEF_gae5e54ab1d82a1bd0f7adb6fab2e73ffd}{oval\_\-test\_\-free} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_gae5e54ab1d82a1bd0f7adb6fab2e73ffd}

\begin{DoxyCompactList}\small\item\em Destruct instance of \hyperlink{structoval__test}{oval\_\-test}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
 }\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__OVALDEF_ga1fce15f743d777ca44ebab29a1392157}{oval\_\-test\_\-set\_\-subtype} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, \hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} subtype)
\begin{DoxyCompactList}\small\item\em Sets attributes \hyperlink{structoval__test}{oval\_\-test}-\/$>$subtype and Oval\_\-test-\/$>$family. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga5feb5d65b2e15e995ccd151e4eb5b873}{oval\_\-test\_\-add\_\-note} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, char $\ast$note)
\begin{DoxyCompactList}\small\item\em Appends a copy of the note parameter to attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$notes. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga2676ed1eb9bfacab4537781d9c8727c0}{oval\_\-test\_\-set\_\-comment} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, char $\ast$comment)
\begin{DoxyCompactList}\small\item\em Sets a copy of the comment parameter to attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$comment. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga92846b3e7c818699421c8f2fc8b28eba}{
void \hyperlink{group__OVALDEF_ga92846b3e7c818699421c8f2fc8b28eba}{oval\_\-test\_\-set\_\-deprecated} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, bool deprecated)}
\label{group__OVALDEF_ga92846b3e7c818699421c8f2fc8b28eba}

\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$deprecated. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga2851958564a793edf5762759cd536014}{oval\_\-test\_\-set\_\-version} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, int version)
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$version. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga7ea4584bce446992d713ee7b8fabdf6b}{oval\_\-test\_\-set\_\-existence} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, \hyperlink{group__OVALDEF_ga523a0461b03a564f296f54a73f99ade1}{oval\_\-existence\_\-t})
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$existence. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_gab8cb734092ee902043074b3d62752896}{oval\_\-test\_\-set\_\-check} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, \hyperlink{group__OVALDEF_ga926ba821c14d2faac9a23b8908c23d70}{oval\_\-check\_\-t})
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$check. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga559dc4e8bfc39ef1aed3c6bac219d299}{oval\_\-test\_\-set\_\-object} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$object. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALDEF_ga64c7dc77d0dd29d97129fa161264cdcf}{oval\_\-test\_\-set\_\-state} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$, struct \hyperlink{structoval__state}{oval\_\-state} $\ast$state)
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$state. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_ga9117f88bc22190b4259f4582e4bdf1ea}{
\hyperlink{group__OVAL_ga83b7e728a31f7ad0a0306ec1408f0a1a}{oval\_\-family\_\-t} \hyperlink{group__OVALDEF_ga9117f88bc22190b4259f4582e4bdf1ea}{oval\_\-test\_\-get\_\-family} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga9117f88bc22190b4259f4582e4bdf1ea}

\begin{DoxyCompactList}\small\item\em Returns attribute Oval\_\-test-\/$>$family. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_gafb0d0e037ebdc3fb821f31b48b9cc971}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} \hyperlink{group__OVALDEF_gafb0d0e037ebdc3fb821f31b48b9cc971}{oval\_\-test\_\-get\_\-subtype} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_gafb0d0e037ebdc3fb821f31b48b9cc971}

\begin{DoxyCompactList}\small\item\em Returns attribute Oval\_\-test-\/$>$subtype. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga495cc1a7ad3ac8e0e7e8bb3fdf5611e5}{oval\_\-test\_\-get\_\-notes} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$notes. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_gaaf2b6790594b8c9059e395b5728430d4}{
char $\ast$ \hyperlink{group__OVALDEF_gaaf2b6790594b8c9059e395b5728430d4}{oval\_\-test\_\-get\_\-comment} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_gaaf2b6790594b8c9059e395b5728430d4}

\begin{DoxyCompactList}\small\item\em Returns attribute Oval\_\-test-\/$>$comment. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga61cf9cf8bb52f48b50e45cd9a688c186}{
char $\ast$ \hyperlink{group__OVALDEF_ga61cf9cf8bb52f48b50e45cd9a688c186}{oval\_\-test\_\-get\_\-id} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga61cf9cf8bb52f48b50e45cd9a688c186}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$id. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga99fc23f8fee128ad33279a8395ed147c}{
bool \hyperlink{group__OVALDEF_ga99fc23f8fee128ad33279a8395ed147c}{oval\_\-test\_\-get\_\-deprecated} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga99fc23f8fee128ad33279a8395ed147c}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$deprecated. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga8c8c00d84d71525d403c4ef6497c7b15}{
int \hyperlink{group__OVALDEF_ga8c8c00d84d71525d403c4ef6497c7b15}{oval\_\-test\_\-get\_\-version} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga8c8c00d84d71525d403c4ef6497c7b15}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$version. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_gaaababad2d3e59cd49613ba81e49fc530}{
\hyperlink{group__OVALDEF_ga523a0461b03a564f296f54a73f99ade1}{oval\_\-existence\_\-t} \hyperlink{group__OVALDEF_gaaababad2d3e59cd49613ba81e49fc530}{oval\_\-test\_\-get\_\-existence} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_gaaababad2d3e59cd49613ba81e49fc530}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$existence. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga0d3de7d44b0a1f25a4f752dfc88ebfa7}{
\hyperlink{group__OVALDEF_ga926ba821c14d2faac9a23b8908c23d70}{oval\_\-check\_\-t} \hyperlink{group__OVALDEF_ga0d3de7d44b0a1f25a4f752dfc88ebfa7}{oval\_\-test\_\-get\_\-check} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga0d3de7d44b0a1f25a4f752dfc88ebfa7}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$check. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga630ee349c16490b939e0b0cacea2dd07}{
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ \hyperlink{group__OVALDEF_ga630ee349c16490b939e0b0cacea2dd07}{oval\_\-test\_\-get\_\-object} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga630ee349c16490b939e0b0cacea2dd07}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$object. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga8f8d1f87d4ed887a4d22742a9713f860}{
struct \hyperlink{structoval__state}{oval\_\-state} $\ast$ \hyperlink{group__OVALDEF_ga8f8d1f87d4ed887a4d22742a9713f860}{oval\_\-test\_\-get\_\-state} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)}
\label{group__OVALDEF_ga8f8d1f87d4ed887a4d22742a9713f860}

\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__test}{oval\_\-test}-\/$>$state. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__OVALDEF_ga25c04b35c1a0585da9c5e9a872aeef26}{oval\_\-test\_\-is\_\-locked} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$test)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the test instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__OVALDEF_gade066ef0fa23488a67c124b042e64941}{oval\_\-test\_\-is\_\-valid} (struct \hyperlink{structoval__test}{oval\_\-test} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns {\bfseries true} if \hyperlink{structoval__test}{oval\_\-test} is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoval__test_a4f0a99336ab0120c9e8719a07e8638f2}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__test_a4f0a99336ab0120c9e8719a07e8638f2}

\item 
\hypertarget{structoval__test_a6e8cb910909df04c2163846a2525f2f0}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} {\bfseries subtype}}
\label{structoval__test_a6e8cb910909df04c2163846a2525f2f0}

\item 
\hypertarget{structoval__test_ae8e1a4d3326ed5e7d1ab89a0a0e7460e}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries notes}}
\label{structoval__test_ae8e1a4d3326ed5e7d1ab89a0a0e7460e}

\item 
\hypertarget{structoval__test_a74b75c04b2e8e9ba5cf8234e19dc9890}{
char $\ast$ {\bfseries comment}}
\label{structoval__test_a74b75c04b2e8e9ba5cf8234e19dc9890}

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

\item 
\hypertarget{structoval__test_a17cbd0189d6b0357cf946146d8dbc628}{
int {\bfseries deprecated}}
\label{structoval__test_a17cbd0189d6b0357cf946146d8dbc628}

\item 
\hypertarget{structoval__test_a6d01a5c86c82dc2a4e7118ea2fb6720f}{
int {\bfseries version}}
\label{structoval__test_a6d01a5c86c82dc2a4e7118ea2fb6720f}

\item 
\hypertarget{structoval__test_a46f7c100458efdefecff3f4a146a4949}{
\hyperlink{group__OVALDEF_ga523a0461b03a564f296f54a73f99ade1}{oval\_\-existence\_\-t} {\bfseries existence}}
\label{structoval__test_a46f7c100458efdefecff3f4a146a4949}

\item 
\hypertarget{structoval__test_a939bbdabe0d75fd4bf1552ef1d7f429c}{
\hyperlink{group__OVALDEF_ga926ba821c14d2faac9a23b8908c23d70}{oval\_\-check\_\-t} {\bfseries check}}
\label{structoval__test_a939bbdabe0d75fd4bf1552ef1d7f429c}

\item 
\hypertarget{structoval__test_ae92d321cc0f4519b588ebc284aeeb933}{
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ {\bfseries object}}
\label{structoval__test_ae92d321cc0f4519b588ebc284aeeb933}

\item 
\hypertarget{structoval__test_af9321763e7f6d15b95adbb6d2d87cfba}{
struct \hyperlink{structoval__state}{oval\_\-state} $\ast$ {\bfseries state}}
\label{structoval__test_af9321763e7f6d15b95adbb6d2d87cfba}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
An Oval\_\-test specifies a technical control by identifying an \hyperlink{structoval__object}{oval\_\-object} that is evaluated on an instrumented host platform and, optionally, an Oval\_\-state instance that matches the object query. 

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