classdmtclientconfig.tex

This SDK allows to integrate a syncml stack in a C++ application on a variety of platforms. Current

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em extNode}]the \char`\"{}spds/syncml/ext\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveExtAccessConfig@{saveExtAccessConfig}}
\index{saveExtAccessConfig@{saveExtAccessConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveExtAccessConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em extNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_8e444cef74effefa5b79b0859a7d51c4}


Same as readAccessConfig() for saving additional access information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em extNode}]the \char`\"{}spds/syncml/ext\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readDevInfoConfig@{readDevInfoConfig}}
\index{readDevInfoConfig@{readDevInfoConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readDevInfoConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em devInfoNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_a545ae8dc4960c6f14821a17b77b6135}


Same as readAccessConfig() for reading device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em devInfoNode}]the \char`\"{}spds/syncml/devinfo\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveDevInfoConfig@{saveDevInfoConfig}}
\index{saveDevInfoConfig@{saveDevInfoConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveDevInfoConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em devInfoNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_d73ffcc00183b9b6c3d55910500c528b}


Same as readAccessConfig() for saving device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em devInfoNode}]the \char`\"{}spds/syncml/devinfo\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readDevDetailConfig@{readDevDetailConfig}}
\index{readDevDetailConfig@{readDevDetailConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readDevDetailConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em devDetailNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_b3e81f1bed1570061071fbe6eb34cf59}


Same as readAccessConfig() for reading additional device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em devDetailNode}]the \char`\"{}spds/syncml/devdetail\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveDevDetailConfig@{saveDevDetailConfig}}
\index{saveDevDetailConfig@{saveDevDetailConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveDevDetailConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em devDetailNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_8fa791299fbfd2dd5580fbfe84096ecc}


Same as readAccessConfig() for saving additional device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em devDetailNode}]the \char`\"{}spds/syncml/devdetail\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readExtDevConfig@{readExtDevConfig}}
\index{readExtDevConfig@{readExtDevConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readExtDevConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em extNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_6d3ba750b4cb3ac7dbd3f55b3e8ee5db}


Same as readAccessConfig() for reading some more additional device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em extNode}]the \char`\"{}spds/syncml/ext\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveExtDevConfig@{saveExtDevConfig}}
\index{saveExtDevConfig@{saveExtDevConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveExtDevConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em extNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_d1e54a9233a239c1e190d8b3166524be}


Same as readAccessConfig() for saving some more additional device information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em extNode}]the \char`\"{}spds/syncml/ext\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readSourceVars@{readSourceVars}}
\index{readSourceVars@{readSourceVars}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readSourceVars (int {\em i}, ManagementNode \& {\em sourcesNode}, ManagementNode \& {\em sourceNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_2edef25fa92a4bcf719adde6ed5a8a1e}


Same as readAccessConfig() for reading variables that the library uses internally, like anchors. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]index of the source \item[{\em sourcesNode}]the \char`\"{}spds/sources\char`\"{} node \item[{\em sourceNode}]the \char`\"{}spds/sources/$<$source name$>$\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveSourceVars@{saveSourceVars}}
\index{saveSourceVars@{saveSourceVars}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveSourceVars (int {\em i}, ManagementNode \& {\em sourcesNode}, ManagementNode \& {\em sourceNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_e729d92f96cf0daf94ddc04dba14cada}


Same as readAccessConfig() for saveing variables that the library uses internally, like anchors. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]index of the source \item[{\em sourcesNode}]the \char`\"{}spds/sources\char`\"{} node \item[{\em sourceNode}]the \char`\"{}spds/sources/$<$source name$>$\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readSourceConfig@{readSourceConfig}}
\index{readSourceConfig@{readSourceConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readSourceConfig (int {\em i}, ManagementNode \& {\em sourcesNode}, ManagementNode \& {\em sourceNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_0d886a037d42acc91138d13a9c413ed7}


Same as readAccessConfig() for reading the normal properties of a sync source, i.e. 

excluding variables like anchors.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]index of the source \item[{\em sourcesNode}]the \char`\"{}spds/sources\char`\"{} node \item[{\em sourceNode}]the \char`\"{}spds/sources/$<$source name$>$\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveSourceConfig@{saveSourceConfig}}
\index{saveSourceConfig@{saveSourceConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveSourceConfig (int {\em i}, ManagementNode \& {\em sourcesNode}, ManagementNode \& {\em sourceNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_6225af83b250762b82005b22479b9d71}


Same as readAccessConfig() for reading the normal properties of a sync source, i.e. 

excluding variables like anchors.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]index of the source \item[{\em sourcesNode}]the \char`\"{}spds/sources\char`\"{} node \item[{\em sourceNode}]the \char`\"{}spds/sources/$<$source name$>$\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!open@{open}}
\index{open@{open}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::open ()\hspace{0.3cm}{\tt  [virtual]}}\label{classDMTClientConfig_137c1220e6cca22a80df3b5226fc01ef}


Opens the configuration backend associated with the root context. 

Calling on an open config does nothing.

\begin{Desc}
\item[Returns:]TRUE for success \end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!getSyncMLNode@{getSyncMLNode}}
\index{getSyncMLNode@{getSyncMLNode}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ManagementNode$\ast$ DMTClientConfig::getSyncMLNode ()\hspace{0.3cm}{\tt  [virtual]}}\label{classDMTClientConfig_4cc10df1e0c67e65f8cf00b7c851ed85}


Provides access to the \char`\"{}syncml\char`\"{} configuration node, can be used to read/write custom configuration options. 

Config must have been opened before.

\begin{Desc}
\item[Returns:]node pointer owned by config and valid while the config is open \end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!getSyncSourceNode@{getSyncSourceNode}}
\index{getSyncSourceNode@{getSyncSourceNode}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ManagementNode$\ast$ DMTClientConfig::getSyncSourceNode (int {\em index})\hspace{0.3cm}{\tt  [virtual]}}\label{classDMTClientConfig_b210962a7ac02452ae8473185434ed88}


Get the specified sync source configuration. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em index}]number of the requested sync source configuration \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]node pointer owned by config and valid while the config is open \end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!close@{close}}
\index{close@{close}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::close ()\hspace{0.3cm}{\tt  [virtual]}}\label{classDMTClientConfig_2e5c2b4755fc8771e63ac326b9517668}


Closes the configuration backend. 

Frees all resources associated with and invalidates all ManagementNode pointers returned by this config. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
src/include/common/client/DMTClientConfig.h\end{CompactItemize}