\doxysubsection{SVM plugin configuration}
\hypertarget{group__pluginconfiguration}{}\label{group__pluginconfiguration}\index{SVM plugin configuration@{SVM plugin configuration}}


This module contains API functions to handle SVM plugin configuration.  


\doxysubsubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__pluginconfiguration_ga017351b1c0968df5e1ff09ce665e8857}{svm\+\_\+plugin\+\_\+has\+\_\+option}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} option)
\begin{DoxyCompactList}\small\item\em This function checks whether an option exists. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__pluginconfiguration_gaf5961c27df44630e67c05e810c5d9ac8}{svm\+\_\+plugin\+\_\+has\+\_\+argument}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} argument)
\begin{DoxyCompactList}\small\item\em This function checks whether an argument exists. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__pluginconfiguration_gad32a441f12a0584b47b10e7894e85813}{svm\+\_\+plugin\+\_\+has\+\_\+arguments}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} arguments)
\begin{DoxyCompactList}\small\item\em This function checks whether an extra argument array exists. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} \mbox{\hyperlink{group__pluginconfiguration_ga03d59fcd171c50bbbdfd26df539ce7ad}{svm\+\_\+plugin\+\_\+get\+\_\+option}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} option)
\begin{DoxyCompactList}\small\item\em This function returns the value associated to an option. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} \mbox{\hyperlink{group__pluginconfiguration_ga2f77082320bd65bad0ed91f1b1e01a64}{svm\+\_\+plugin\+\_\+get\+\_\+argument}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} argument)
\begin{DoxyCompactList}\small\item\em This function returns the value associated to an argument. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__pluginconfiguration_ga0e7705567fb995beaba3ed993ce03374}{svm\+\_\+plugin\+\_\+get\+\_\+arguments}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}} arguments)
\begin{DoxyCompactList}\small\item\em This function returns the values array associated to an extra arguments array. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsubsection{Detailed Description}
This module contains API functions to handle SVM plugin configuration. 

These functions allow plugin code to check and retrieve values associated to the options and arguments passed at plugin invokation. 

\doxysubsubsection{Function Documentation}
\Hypertarget{group__pluginconfiguration_ga2f77082320bd65bad0ed91f1b1e01a64}\label{group__pluginconfiguration_ga2f77082320bd65bad0ed91f1b1e01a64} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_get\_argument@{svm\_plugin\_get\_argument}}
\index{svm\_plugin\_get\_argument@{svm\_plugin\_get\_argument}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_get\_argument()}{svm\_plugin\_get\_argument()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} svm\+\_\+plugin\+\_\+get\+\_\+argument (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{argument }\end{DoxyParamCaption})}



This function returns the value associated to an argument. 


\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 argument} & The argument name of the value to retrieve.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The value associated to the argument.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The value is constant and can have a type among integer and string.
\end{DoxyNote}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the argument does not exist.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__pluginconfiguration_gaf5961c27df44630e67c05e810c5d9ac8}{svm\+\_\+plugin\+\_\+has\+\_\+argument} 
\end{DoxySeeAlso}
\Hypertarget{group__pluginconfiguration_ga0e7705567fb995beaba3ed993ce03374}\label{group__pluginconfiguration_ga0e7705567fb995beaba3ed993ce03374} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_get\_arguments@{svm\_plugin\_get\_arguments}}
\index{svm\_plugin\_get\_arguments@{svm\_plugin\_get\_arguments}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_get\_arguments()}{svm\_plugin\_get\_arguments()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} \texorpdfstring{$\ast$}{*} svm\+\_\+plugin\+\_\+get\+\_\+arguments (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{arguments }\end{DoxyParamCaption})}



This function returns the values array associated to an extra arguments array. 


\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 arguments} & The extra arguments array name of the value to retrieve.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The values array associated to the extra arguments array, terminated by a C null pointer.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The values are constant and can have a type among integer and string.
\end{DoxyNote}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the extra arguments array does not exist.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__pluginconfiguration_gad32a441f12a0584b47b10e7894e85813}{svm\+\_\+plugin\+\_\+has\+\_\+arguments} 
\end{DoxySeeAlso}
\Hypertarget{group__pluginconfiguration_ga03d59fcd171c50bbbdfd26df539ce7ad}\label{group__pluginconfiguration_ga03d59fcd171c50bbbdfd26df539ce7ad} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_get\_option@{svm\_plugin\_get\_option}}
\index{svm\_plugin\_get\_option@{svm\_plugin\_get\_option}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_get\_option()}{svm\_plugin\_get\_option()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} svm\+\_\+plugin\+\_\+get\+\_\+option (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{option }\end{DoxyParamCaption})}



This function returns the value associated to an option. 


\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 option} & The option name of the value to retrieve.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The value associated to the option.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
The value is constant, can be null and can have a type among integer, string and boolean.
\end{DoxyNote}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the option does not exist.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__pluginconfiguration_ga017351b1c0968df5e1ff09ce665e8857}{svm\+\_\+plugin\+\_\+has\+\_\+option} 
\end{DoxySeeAlso}
\Hypertarget{group__pluginconfiguration_gaf5961c27df44630e67c05e810c5d9ac8}\label{group__pluginconfiguration_gaf5961c27df44630e67c05e810c5d9ac8} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_has\_argument@{svm\_plugin\_has\_argument}}
\index{svm\_plugin\_has\_argument@{svm\_plugin\_has\_argument}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_has\_argument()}{svm\_plugin\_has\_argument()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+plugin\+\_\+has\+\_\+argument (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{argument }\end{DoxyParamCaption})}



This function checks whether an argument exists. 


\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 argument} & The argument name to check.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the argument exists, 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}
\Hypertarget{group__pluginconfiguration_gad32a441f12a0584b47b10e7894e85813}\label{group__pluginconfiguration_gad32a441f12a0584b47b10e7894e85813} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_has\_arguments@{svm\_plugin\_has\_arguments}}
\index{svm\_plugin\_has\_arguments@{svm\_plugin\_has\_arguments}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_has\_arguments()}{svm\_plugin\_has\_arguments()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+plugin\+\_\+has\+\_\+arguments (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{arguments }\end{DoxyParamCaption})}



This function checks whether an extra argument array exists. 


\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 arguments} & The extra argument array name to check.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the extra argument array exists, 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}
\Hypertarget{group__pluginconfiguration_ga017351b1c0968df5e1ff09ce665e8857}\label{group__pluginconfiguration_ga017351b1c0968df5e1ff09ce665e8857} 
\index{SVM plugin configuration@{SVM plugin configuration}!svm\_plugin\_has\_option@{svm\_plugin\_has\_option}}
\index{svm\_plugin\_has\_option@{svm\_plugin\_has\_option}!SVM plugin configuration@{SVM plugin configuration}}
\doxysubsubsubsection{\texorpdfstring{svm\_plugin\_has\_option()}{svm\_plugin\_has\_option()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+plugin\+\_\+has\+\_\+option (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga90c57554e1d1ea2967e133696d0cf2cd}{SVM\+\_\+\+Value\+\_\+\+Plugin\+Entry\+Point}}}]{option }\end{DoxyParamCaption})}



This function checks whether an option exists. 


\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 option} & The option name to check.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the option exists, 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}
