\hypertarget{classagora_1_1base_1_1_i_agora_parameter}{}\doxysection{agora\+::base\+::I\+Agora\+Parameter Class Reference}
\label{classagora_1_1base_1_1_i_agora_parameter}\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
Inheritance diagram for agora\+::base\+::I\+Agora\+Parameter\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classagora_1_1base_1_1_i_agora_parameter}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual void \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a95510eeb7182682e9428d3b86bdc8251}{release}} ()=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a7f3d8dc475601350e2336888fb68d70c}{set\+Bool}} (const char $\ast$key, bool value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_ae77f4d6f80f21d30923162b5724573bd}{set\+Int}} (const char $\ast$key, int value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a6356b6b75e40d2a7e139153276fdfc94}{set\+U\+Int}} (const char $\ast$key, unsigned int value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a5841004d812e8b131f5cf2a066090c31}{set\+Number}} (const char $\ast$key, double value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a5e3d5402b9978bc451581455fc5bc87d}{set\+String}} (const char $\ast$key, const char $\ast$value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_abde962329cd71e9ce47cbfd1bcc0d397}{set\+Object}} (const char $\ast$key, const char $\ast$value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_ab9cd5c8b2c2a205e0d6d25ab7162f95b}{set\+Array}} (const char $\ast$key, const char $\ast$value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_ab5aff4601e74166960793932a0d7cd79}{get\+Bool}} (const char $\ast$key, bool \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a440b9be48455b99e07bade737dc82efc}{get\+Int}} (const char $\ast$key, int \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_af77c75f9db8bb0d8eb11e18703f3089b}{get\+U\+Int}} (const char $\ast$key, unsigned int \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_abc050f5d2193c8c90274bdefc748b872}{get\+Number}} (const char $\ast$key, double \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_aa05100404aa303913a0be4443c206f8d}{get\+String}} (const char $\ast$key, \mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a7d92d5d87f5f9f4746e4bae774a82e0c}{get\+Object}} (const char $\ast$key, \mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a6a4e92fbed01182f6d6acc0e1924ef8b}{get\+Array}} (const char $\ast$key, const char $\ast$args, \mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&value)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1base_1_1_i_agora_parameter_a29bec1ab93c40253b098483e039bd702}{set\+Parameters}} (const char $\ast$parameters)=0
\item 
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a9ee6f44dd449f69b3b53dd57639a60a5}\label{classagora_1_1base_1_1_i_agora_parameter_a9ee6f44dd449f69b3b53dd57639a60a5}} 
virtual int {\bfseries convert\+Path} (const char $\ast$file\+Path, \mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&value)=0
\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a95510eeb7182682e9428d3b86bdc8251}\label{classagora_1_1base_1_1_i_agora_parameter_a95510eeb7182682e9428d3b86bdc8251}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!release@{release}}
\index{release@{release}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{release()}{release()}}
{\footnotesize\ttfamily virtual void agora\+::base\+::\+I\+Agora\+Parameter\+::release (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

release the resource \mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a7f3d8dc475601350e2336888fb68d70c}\label{classagora_1_1base_1_1_i_agora_parameter_a7f3d8dc475601350e2336888fb68d70c}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setBool@{setBool}}
\index{setBool@{setBool}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setBool()}{setBool()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Bool (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{bool}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set bool value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_ae77f4d6f80f21d30923162b5724573bd}\label{classagora_1_1base_1_1_i_agora_parameter_ae77f4d6f80f21d30923162b5724573bd}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setInt@{setInt}}
\index{setInt@{setInt}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setInt()}{setInt()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Int (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{int}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set int value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a6356b6b75e40d2a7e139153276fdfc94}\label{classagora_1_1base_1_1_i_agora_parameter_a6356b6b75e40d2a7e139153276fdfc94}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setUInt@{setUInt}}
\index{setUInt@{setUInt}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setUInt()}{setUInt()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+U\+Int (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{unsigned int}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set unsigned int value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a5841004d812e8b131f5cf2a066090c31}\label{classagora_1_1base_1_1_i_agora_parameter_a5841004d812e8b131f5cf2a066090c31}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setNumber@{setNumber}}
\index{setNumber@{setNumber}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setNumber()}{setNumber()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Number (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{double}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set double value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a5e3d5402b9978bc451581455fc5bc87d}\label{classagora_1_1base_1_1_i_agora_parameter_a5e3d5402b9978bc451581455fc5bc87d}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setString@{setString}}
\index{setString@{setString}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setString()}{setString()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+String (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{const char $\ast$}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set string value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_abde962329cd71e9ce47cbfd1bcc0d397}\label{classagora_1_1base_1_1_i_agora_parameter_abde962329cd71e9ce47cbfd1bcc0d397}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setObject@{setObject}}
\index{setObject@{setObject}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setObject()}{setObject()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Object (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{const char $\ast$}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set object value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_ab9cd5c8b2c2a205e0d6d25ab7162f95b}\label{classagora_1_1base_1_1_i_agora_parameter_ab9cd5c8b2c2a205e0d6d25ab7162f95b}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setArray@{setArray}}
\index{setArray@{setArray}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setArray()}{setArray()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Array (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{const char $\ast$}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set array value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_ab5aff4601e74166960793932a0d7cd79}\label{classagora_1_1base_1_1_i_agora_parameter_ab5aff4601e74166960793932a0d7cd79}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getBool@{getBool}}
\index{getBool@{getBool}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getBool()}{getBool()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+Bool (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{bool \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get bool value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a440b9be48455b99e07bade737dc82efc}\label{classagora_1_1base_1_1_i_agora_parameter_a440b9be48455b99e07bade737dc82efc}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getInt@{getInt}}
\index{getInt@{getInt}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getInt()}{getInt()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+Int (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{int \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get int value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_af77c75f9db8bb0d8eb11e18703f3089b}\label{classagora_1_1base_1_1_i_agora_parameter_af77c75f9db8bb0d8eb11e18703f3089b}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getUInt@{getUInt}}
\index{getUInt@{getUInt}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getUInt()}{getUInt()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+U\+Int (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{unsigned int \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get unsigned int value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_abc050f5d2193c8c90274bdefc748b872}\label{classagora_1_1base_1_1_i_agora_parameter_abc050f5d2193c8c90274bdefc748b872}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getNumber@{getNumber}}
\index{getNumber@{getNumber}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getNumber()}{getNumber()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+Number (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{double \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get double value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_aa05100404aa303913a0be4443c206f8d}\label{classagora_1_1base_1_1_i_agora_parameter_aa05100404aa303913a0be4443c206f8d}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getString@{getString}}
\index{getString@{getString}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getString()}{getString()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+String (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{\mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get string value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a7d92d5d87f5f9f4746e4bae774a82e0c}\label{classagora_1_1base_1_1_i_agora_parameter_a7d92d5d87f5f9f4746e4bae774a82e0c}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getObject@{getObject}}
\index{getObject@{getObject}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getObject()}{getObject()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+Object (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{\mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get a child object value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a6a4e92fbed01182f6d6acc0e1924ef8b}\label{classagora_1_1base_1_1_i_agora_parameter_a6a4e92fbed01182f6d6acc0e1924ef8b}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!getArray@{getArray}}
\index{getArray@{getArray}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{getArray()}{getArray()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::get\+Array (\begin{DoxyParamCaption}\item[{const char $\ast$}]{key,  }\item[{const char $\ast$}]{args,  }\item[{\mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

get array value of the json 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em key} & the key name \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & the value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1base_1_1_i_agora_parameter_a29bec1ab93c40253b098483e039bd702}\label{classagora_1_1base_1_1_i_agora_parameter_a29bec1ab93c40253b098483e039bd702}} 
\index{agora::base::IAgoraParameter@{agora::base::IAgoraParameter}!setParameters@{setParameters}}
\index{setParameters@{setParameters}!agora::base::IAgoraParameter@{agora::base::IAgoraParameter}}
\doxysubsubsection{\texorpdfstring{setParameters()}{setParameters()}}
{\footnotesize\ttfamily virtual int agora\+::base\+::\+I\+Agora\+Parameter\+::set\+Parameters (\begin{DoxyParamCaption}\item[{const char $\ast$}]{parameters }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

set parameters of the sdk or engine 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em parameters} & the parameters \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
return 0 if success or an error code 
\end{DoxyReturn}
