\hypertarget{structoval__syschar}{
\section{oval\_\-syschar Struct Reference}
\label{structoval__syschar}\index{oval\_\-syschar@{oval\_\-syschar}}
}
Characteristics bound to an Oval\_\-object.
{\ttfamily \#include $<$oval\_\-system\_\-characteristics.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALSYS_ga26b6dd1dc1337ad091a7381fd39cd799}{
struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$ {\bfseries oval\_\-syschar\_\-new} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$, struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALSYS_ga26b6dd1dc1337ad091a7381fd39cd799}
\item
\hypertarget{group__OVALSYS_ga6415412edc540f73202c9552093e8301}{
struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$ {\bfseries oval\_\-syschar\_\-clone} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$new\_\-model, struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$old\_\-syschar)}
\label{group__OVALSYS_ga6415412edc540f73202c9552093e8301}
\item
\hypertarget{group__OVALSYS_ga50aeb1489d363426c0fcee74f0142bb9}{
void {\bfseries oval\_\-syschar\_\-free} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_ga50aeb1489d363426c0fcee74f0142bb9}
\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALSYS_gabcbd7bbe2af28f401338dc9e4853e1be}{
void {\bfseries oval\_\-syschar\_\-add\_\-variable\_\-binding} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$, struct \hyperlink{structoval__variable__binding}{oval\_\-variable\_\-binding} $\ast$)}
\label{group__OVALSYS_gabcbd7bbe2af28f401338dc9e4853e1be}
\item
\hypertarget{group__OVALSYS_ga175d0c36e80feada9b5940037aeaac52}{
void {\bfseries oval\_\-syschar\_\-set\_\-flag} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$model, \hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} flag)}
\label{group__OVALSYS_ga175d0c36e80feada9b5940037aeaac52}
\item
\hypertarget{group__OVALSYS_ga3f339c44ae4bda8eca6d121be1a2081a}{
void {\bfseries oval\_\-syschar\_\-set\_\-object} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$, struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALSYS_ga3f339c44ae4bda8eca6d121be1a2081a}
\item
\hypertarget{group__OVALSYS_gaa8ffc4b5646e26a8fd1bf889f6336f79}{
void {\bfseries oval\_\-syschar\_\-add\_\-sysdata} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$, struct \hyperlink{structoval__sysdata}{oval\_\-sysdata} $\ast$)}
\label{group__OVALSYS_gaa8ffc4b5646e26a8fd1bf889f6336f79}
\item
\hypertarget{group__OVALSYS_ga7f9a6c539fe4661ed162708e1322345e}{
void {\bfseries oval\_\-syschar\_\-add\_\-message} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$syschar, struct \hyperlink{structoval__message}{oval\_\-message} $\ast$message)}
\label{group__OVALSYS_ga7f9a6c539fe4661ed162708e1322345e}
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALSYS_ga689a43dbc2760246d3d5c53b4db12e3d}{
\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} \hyperlink{group__OVALSYS_ga689a43dbc2760246d3d5c53b4db12e3d}{oval\_\-syschar\_\-get\_\-flag} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_ga689a43dbc2760246d3d5c53b4db12e3d}
\begin{DoxyCompactList}\small\item\em Get system characteristic flag. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALSYS_ga0c72eeff03e93230e915f34acfac5ae4}{
struct \hyperlink{structoval__message__iterator}{oval\_\-message\_\-iterator} $\ast$ \hyperlink{group__OVALSYS_ga0c72eeff03e93230e915f34acfac5ae4}{oval\_\-syschar\_\-get\_\-messages} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_ga0c72eeff03e93230e915f34acfac5ae4}
\begin{DoxyCompactList}\small\item\em Get messages bound to this system characteristic. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALSYS_ga75271cf87c92dda9633d1b0875bd5ac4}{
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ \hyperlink{group__OVALSYS_ga75271cf87c92dda9633d1b0875bd5ac4}{oval\_\-syschar\_\-get\_\-object} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_ga75271cf87c92dda9633d1b0875bd5ac4}
\begin{DoxyCompactList}\small\item\em Get object associated with this system characteristic. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALSYS_ga5376f1d40f8bfba1e44ba0943fa4bdc5}{
struct \hyperlink{structoval__variable__binding__iterator}{oval\_\-variable\_\-binding\_\-iterator} $\ast$ \hyperlink{group__OVALSYS_ga5376f1d40f8bfba1e44ba0943fa4bdc5}{oval\_\-syschar\_\-get\_\-variable\_\-bindings} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_ga5376f1d40f8bfba1e44ba0943fa4bdc5}
\begin{DoxyCompactList}\small\item\em Get system characteristic variable bindings. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALSYS_gaf19bcb77e6af5896e4e3b7305bebed19}{
struct \hyperlink{structoval__sysdata__iterator}{oval\_\-sysdata\_\-iterator} $\ast$ \hyperlink{group__OVALSYS_gaf19bcb77e6af5896e4e3b7305bebed19}{oval\_\-syschar\_\-get\_\-sysdata} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$)}
\label{group__OVALSYS_gaf19bcb77e6af5896e4e3b7305bebed19}
\begin{DoxyCompactList}\small\item\em Get system characteristic data. \item\end{DoxyCompactList}\item
bool \hyperlink{group__OVALSYS_gaacf50ef25b441c5f2bbbc7b05556fa3d}{oval\_\-syschar\_\-is\_\-locked} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$syschar)
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the syschar instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALSYS_ga0e2baee3c2910ebf52942b30e93ba998}{
bool \hyperlink{group__OVALSYS_ga0e2baee3c2910ebf52942b30e93ba998}{oval\_\-syschar\_\-is\_\-valid} (struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$syschar)}
\label{group__OVALSYS_ga0e2baee3c2910ebf52942b30e93ba998}
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the syschar instance is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structoval__syschar_a7c60303771a746f82d2704d0eb0afd26}{
struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$ {\bfseries model}}
\label{structoval__syschar_a7c60303771a746f82d2704d0eb0afd26}
\item
\hypertarget{structoval__syschar_acc9214c0eb49784cdff4e4500556def7}{
\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} {\bfseries flag}}
\label{structoval__syschar_acc9214c0eb49784cdff4e4500556def7}
\item
\hypertarget{structoval__syschar_a0ea1eee36449e8c05a4b621d00a56617}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries messages}}
\label{structoval__syschar_a0ea1eee36449e8c05a4b621d00a56617}
\item
\hypertarget{structoval__syschar_a2efee5219ed219af70b05d0fb55cb5d6}{
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ {\bfseries object}}
\label{structoval__syschar_a2efee5219ed219af70b05d0fb55cb5d6}
\item
\hypertarget{structoval__syschar_af8cfd1e99c042a559a5f2f267270787b}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries variable\_\-bindings}}
\label{structoval__syschar_af8cfd1e99c042a559a5f2f267270787b}
\item
\hypertarget{structoval__syschar_ae5b117715779a6c80a4ec41665abcde8}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries sysdata}}
\label{structoval__syschar_ae5b117715779a6c80a4ec41665abcde8}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Characteristics bound to an Oval\_\-object. Instances of Oval\_\-syschar provide relate an Oval\_\-object and Oval\_\-sysdata instances.
If an OVAL Object does not exist on the system, then an object is still provided but with the flag attribute set to 'does not exist' and with no reference child elements. This shows that the object was looked for but not found on the system. If no object element is written in this case, users of the system characteristics file will not know whether the object was not found or no attempt was made to collect it.
The flag attribute holds information regarding the outcome of the data collection. For example, if there was an error looking for items that match the object specification, then the flag would be 'error'. Please refer to the description of FlagEnumeration for details about the different flag values.
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__syschar_8c}{oval\_\-syschar.c}\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/public/\hyperlink{oval__system__characteristics_8h}{oval\_\-system\_\-characteristics.h}\end{DoxyCompactItemize}
