\hypertarget{group__values}{}\doxysection{SVM values}
\label{group__values}\index{SVM values@{SVM values}}


This module contains API functions to handle SVM values.  


\doxysubsection*{Modules}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__integervalues}{SVM integer values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM integer values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__stringvalues}{SVM string values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM string values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__booleanvalues}{SVM boolean values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM boolean values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__pointervalues}{SVM pointer values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM pointer values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__libraryvalues}{SVM library values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM library values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__symbolvalues}{SVM symbol values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM symbol values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__pluginentrypointvalues}{SVM plugin entry point values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM plugin entry point values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__interruptionvalues}{SVM interruption values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM interruption values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__pluginvalues}{SVM plugin values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM plugin values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__automaticvalues}{SVM automatic values}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM automatic values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__valuestypes}{SVM values types}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM values types. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__valuesstate}{SVM values state}}
\begin{DoxyCompactList}\small\item\em This module contains API functions to handle SVM values state. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___comparison___result}{SVM\+\_\+\+Comparison\+\_\+\+Result}} \mbox{\hyperlink{group__values_ga2608cfb8112b8e120c50f420089ae76c}{svm\+\_\+value\+\_\+compare}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} left, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} right)
\begin{DoxyCompactList}\small\item\em This function compares two values. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__values_gafe3302b5033e112ffab87e548a6a701f}{svm\+\_\+value\+\_\+is\+\_\+equal}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} left, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} right)
\begin{DoxyCompactList}\small\item\em This function checks whether two values are equal. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} \mbox{\hyperlink{group__values_gadb107252b652570de2ae0592ac479fae}{svm\+\_\+value\+\_\+copy}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} value)
\begin{DoxyCompactList}\small\item\em This function creates a copy from a value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}} \mbox{\hyperlink{group__values_ga3556d5912c7a696278eeb6346c351280}{svm\+\_\+value\+\_\+print}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} value)
\begin{DoxyCompactList}\small\item\em This function extracts a string representation of a value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} $\ast$ \mbox{\hyperlink{group__values_ga65a14d63852f35e1ec45777de3fec89e}{svm\+\_\+value\+\_\+array\+\_\+new}} (const void $\ast$svm, \mbox{\hyperlink{group__api__types_gaab347fe7005c87722bd7d80cfe94333c}{SVM\+\_\+\+Size}} size)
\begin{DoxyCompactList}\small\item\em This function creates an array of values. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This module contains API functions to handle SVM values. 

Values are containers for data a memory can store.

\begin{DoxyNote}{Note}
In parameters, values are always passed by reference. Using a set API function on a value passed on a parameter containing a value read from a memory will change the value directly in the memory. This can be used to implement an \char`\"{}extra return parameter\char`\"{} or use a value in memory as a state between several plugin callback function calls.
\end{DoxyNote}
\begin{DoxyWarning}{Warning}
Changing a value written in memory will bypass all eventual memory synchronisation mecanisms. Use this feature with caution.
\end{DoxyWarning}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__memories}{SVM memories}} 

\mbox{\hyperlink{group__synchronisationmemory}{SVM memory synchronisation}} 
\end{DoxySeeAlso}


\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__values_ga65a14d63852f35e1ec45777de3fec89e}\label{group__values_ga65a14d63852f35e1ec45777de3fec89e}} 
\index{SVM values@{SVM values}!svm\_value\_array\_new@{svm\_value\_array\_new}}
\index{svm\_value\_array\_new@{svm\_value\_array\_new}!SVM values@{SVM values}}
\doxysubsubsection{\texorpdfstring{svm\_value\_array\_new()}{svm\_value\_array\_new()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} $\ast$ svm\+\_\+value\+\_\+array\+\_\+new (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{\mbox{\hyperlink{group__api__types_gaab347fe7005c87722bd7d80cfe94333c}{SVM\+\_\+\+Size}}}]{size }\end{DoxyParamCaption})}



This function creates an array of values. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em size} & The size of the array.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A pointer to a C array of SVM\+\_\+\+Value. Every cell of the array has to be initialised by a value before being passed to an API function.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The returned array is a valid SVM variable\+: its scope can be changed if needed, and the pointer shall not be freed explicitely.
\end{DoxyNote}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{group__values_ga2608cfb8112b8e120c50f420089ae76c}\label{group__values_ga2608cfb8112b8e120c50f420089ae76c}} 
\index{SVM values@{SVM values}!svm\_value\_compare@{svm\_value\_compare}}
\index{svm\_value\_compare@{svm\_value\_compare}!SVM values@{SVM values}}
\doxysubsubsection{\texorpdfstring{svm\_value\_compare()}{svm\_value\_compare()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___comparison___result}{SVM\+\_\+\+Comparison\+\_\+\+Result}} svm\+\_\+value\+\_\+compare (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{left,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{right }\end{DoxyParamCaption})}



This function compares two values. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em left} & The left operand of the equality. \\
\hline
\mbox{\texttt{ in}}  & {\em right} & The right operand of the equality.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The comparison status of the two values.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.)\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{struct_s_v_m___comparison___result}{SVM\+\_\+\+Comparison\+\_\+\+Result}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__values_gadb107252b652570de2ae0592ac479fae}\label{group__values_gadb107252b652570de2ae0592ac479fae}} 
\index{SVM values@{SVM values}!svm\_value\_copy@{svm\_value\_copy}}
\index{svm\_value\_copy@{svm\_value\_copy}!SVM values@{SVM values}}
\doxysubsubsection{\texorpdfstring{svm\_value\_copy()}{svm\_value\_copy()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} svm\+\_\+value\+\_\+copy (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{value }\end{DoxyParamCaption})}



This function creates a copy from a value. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em value} & The value to be copied.\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
If a value can not be copied, a MEMORY interruption is raised.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
The non-\/constant copy of the value.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em MEMORY} & interruption when the value can not be copied. \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{group__values_gafe3302b5033e112ffab87e548a6a701f}\label{group__values_gafe3302b5033e112ffab87e548a6a701f}} 
\index{SVM values@{SVM values}!svm\_value\_is\_equal@{svm\_value\_is\_equal}}
\index{svm\_value\_is\_equal@{svm\_value\_is\_equal}!SVM values@{SVM values}}
\doxysubsubsection{\texorpdfstring{svm\_value\_is\_equal()}{svm\_value\_is\_equal()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+value\+\_\+is\+\_\+equal (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{left,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{right }\end{DoxyParamCaption})}



This function checks whether two values are equal. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em left} & The left operand of the equality. \\
\hline
\mbox{\texttt{ in}}  & {\em right} & The right operand of the equality.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the two values have the same type and the same value, FALSE otherwise.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.)\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__values_ga2608cfb8112b8e120c50f420089ae76c}{svm\+\_\+value\+\_\+compare}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__values_ga3556d5912c7a696278eeb6346c351280}\label{group__values_ga3556d5912c7a696278eeb6346c351280}} 
\index{SVM values@{SVM values}!svm\_value\_print@{svm\_value\_print}}
\index{svm\_value\_print@{svm\_value\_print}!SVM values@{SVM values}}
\doxysubsubsection{\texorpdfstring{svm\_value\_print()}{svm\_value\_print()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}} svm\+\_\+value\+\_\+print (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{value }\end{DoxyParamCaption})}



This function extracts a string representation of a value. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em value} & The value to be rendered as string.\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
If a value can not correctly rendered, an ugly default rendering is returned instead.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
The string representation of the value.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
\end{DoxyExceptions}
