313 lines
21 KiB
TeX
313 lines
21 KiB
TeX
\doxysection{config.\+h File Reference}
|
|
\hypertarget{config_8h}{}\label{config_8h}\index{config.h@{config.h}}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structconfigEntry}{config\+Entry}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Macros}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_ac1a724419200e9f961dc787950aecd2b}{NO\+\_\+\+SECTION}}~0
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a02f5a0519bc0372946e64d593c0c58ce}{FOUND\+\_\+\+SECTION}}~10
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_abc212059095802b47f10a6a49fd45abc}{ERROR\+\_\+\+STR}}~1001
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a39de51bdb6918a63eac8b1bb474e2b84}{ERROR\+\_\+\+MAX\+\_\+\+LEN}}~2
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a258bb72419ef143530a2f8f55e7d57af}{NO\+\_\+\+ERROR}}~0
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a0000658c96c7c74c0904aafe03429a7d}{ERROR\+\_\+\+DELIMITER\+\_\+\+NOT\+\_\+\+FOUND}}~40
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a07c5dd6a63f85102afff94734b066db6}{ST\+\_\+\+INIT}}~0
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a4aa0fcd1d1c19c873711c0dbdf590f51}{ST\+\_\+\+FOUND\+\_\+\+LEFT\+\_\+\+DELIMITER}}~1
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a109ad3408cd20ac98f7063ad33ee151c}{ST\+\_\+\+FOUND\+\_\+\+RIGHT\+\_\+\+DELIMITER}}~2
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_aea1c2232d9f2837fbb565f13e5d7e8ea}{ST\+\_\+\+ERROR\+\_\+\+NOT\+\_\+\+FOUND\+\_\+\+RIGHT\+\_\+\+DELIMITER}}~3
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_afae21c34cd1bfa910d95db50f151c81c}{ST\+\_\+\+ERROR\+\_\+\+NOT\+\_\+\+FOUND\+\_\+\+LEFT\+\_\+\+DELIMITER}}~4
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a50f0255611b79622dbca5cf9c27b7f43}{ST\+\_\+\+FOUND\+\_\+\+SECTION}}~5
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a71a276bab1ecc5d309fe1593a1640d5d}{ST\+\_\+\+SKIP\+\_\+\+READ}}~6
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_a587e636e48ca212f7c964a93ae005e03}{ST\+\_\+\+FINISH}}~20
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_ad89f5843f6a9cdc6a61d5af4734cd75d}{ST\+\_\+\+ERROR\+\_\+\+GETSTRATPOS}}~30
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_aa454692b60895f7025f12b1e0065acea}{MAX\+\_\+\+LEN\+\_\+\+SECTIONNAME}}~128
|
|
\item
|
|
\#define \mbox{\hyperlink{config_8h_ae0f18393ca3f7c151a4e58ae35b119f7}{ERR\+\_\+\+PARSECONFIG\+\_\+\+UNKNOWN}}~201
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
int \mbox{\hyperlink{config_8h_acbd35a1e4b5f0eea312f8cb64f898d4b}{load\+Config}} (char \texorpdfstring{$\ast$}{*}file, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}str\+\_\+entry, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}host, int \texorpdfstring{$\ast$}{*}intervall, int size)
|
|
\item
|
|
int \mbox{\hyperlink{config_8h_aae86bc3f3ebba4d6aba3ca1392c0126a}{check\+Section}} (char \texorpdfstring{$\ast$}{*}str, char delimiter\+Left, char delimiter\+Right, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}section\+Name)
|
|
\begin{DoxyCompactList}\small\item\em Here we check if the given string contains a section for example \mbox{[}SECTIONName\mbox{]} here delimiter\+Left is \mbox{[} and delimiter\+Right is \mbox{]} if a section is found, the section name will be written to section\+Name. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{config_8h_a699e504c1ab9ceffb828dbf365a5e374}{get\+Str\+At\+Pos}} (char \texorpdfstring{$\ast$}{*}str, int from\+Pos, int to\+Pos, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name, int size\+Name)
|
|
\item
|
|
int \mbox{\hyperlink{config_8h_ab0b547ee554d9b305adc1b2ad85080a3}{get\+Name\+Value\+Pair}} (char \texorpdfstring{$\ast$}{*}str, char left\+Delimiter\+Pos, char right\+Delimiter\+Pos, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}value, int size\+Name, int size\+Value)
|
|
\item
|
|
int \mbox{\hyperlink{config_8h_aa8a964c95239ab762c37713f5f53a583}{parse\+Config}} (char \texorpdfstring{$\ast$}{*}buffer, struct \mbox{\hyperlink{structconfigEntry}{config\+Entry}} \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}entry, int config\+Size, int \texorpdfstring{$\ast$}{*}returned\+Count)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Macro Definition Documentation}
|
|
\Hypertarget{config_8h_ae0f18393ca3f7c151a4e58ae35b119f7}\index{config.h@{config.h}!ERR\_PARSECONFIG\_UNKNOWN@{ERR\_PARSECONFIG\_UNKNOWN}}
|
|
\index{ERR\_PARSECONFIG\_UNKNOWN@{ERR\_PARSECONFIG\_UNKNOWN}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ERR\_PARSECONFIG\_UNKNOWN}{ERR\_PARSECONFIG\_UNKNOWN}}
|
|
{\footnotesize\ttfamily \label{config_8h_ae0f18393ca3f7c151a4e58ae35b119f7}
|
|
\#define ERR\+\_\+\+PARSECONFIG\+\_\+\+UNKNOWN~201}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00028}{28}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a0000658c96c7c74c0904aafe03429a7d}\index{config.h@{config.h}!ERROR\_DELIMITER\_NOT\_FOUND@{ERROR\_DELIMITER\_NOT\_FOUND}}
|
|
\index{ERROR\_DELIMITER\_NOT\_FOUND@{ERROR\_DELIMITER\_NOT\_FOUND}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ERROR\_DELIMITER\_NOT\_FOUND}{ERROR\_DELIMITER\_NOT\_FOUND}}
|
|
{\footnotesize\ttfamily \label{config_8h_a0000658c96c7c74c0904aafe03429a7d}
|
|
\#define ERROR\+\_\+\+DELIMITER\+\_\+\+NOT\+\_\+\+FOUND~40}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00007}{7}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a39de51bdb6918a63eac8b1bb474e2b84}\index{config.h@{config.h}!ERROR\_MAX\_LEN@{ERROR\_MAX\_LEN}}
|
|
\index{ERROR\_MAX\_LEN@{ERROR\_MAX\_LEN}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ERROR\_MAX\_LEN}{ERROR\_MAX\_LEN}}
|
|
{\footnotesize\ttfamily \label{config_8h_a39de51bdb6918a63eac8b1bb474e2b84}
|
|
\#define ERROR\+\_\+\+MAX\+\_\+\+LEN~2}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00004}{4}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_abc212059095802b47f10a6a49fd45abc}\index{config.h@{config.h}!ERROR\_STR@{ERROR\_STR}}
|
|
\index{ERROR\_STR@{ERROR\_STR}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ERROR\_STR}{ERROR\_STR}}
|
|
{\footnotesize\ttfamily \label{config_8h_abc212059095802b47f10a6a49fd45abc}
|
|
\#define ERROR\+\_\+\+STR~1001}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00003}{3}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a02f5a0519bc0372946e64d593c0c58ce}\index{config.h@{config.h}!FOUND\_SECTION@{FOUND\_SECTION}}
|
|
\index{FOUND\_SECTION@{FOUND\_SECTION}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{FOUND\_SECTION}{FOUND\_SECTION}}
|
|
{\footnotesize\ttfamily \label{config_8h_a02f5a0519bc0372946e64d593c0c58ce}
|
|
\#define FOUND\+\_\+\+SECTION~10}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00002}{2}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_aa454692b60895f7025f12b1e0065acea}\index{config.h@{config.h}!MAX\_LEN\_SECTIONNAME@{MAX\_LEN\_SECTIONNAME}}
|
|
\index{MAX\_LEN\_SECTIONNAME@{MAX\_LEN\_SECTIONNAME}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{MAX\_LEN\_SECTIONNAME}{MAX\_LEN\_SECTIONNAME}}
|
|
{\footnotesize\ttfamily \label{config_8h_aa454692b60895f7025f12b1e0065acea}
|
|
\#define MAX\+\_\+\+LEN\+\_\+\+SECTIONNAME~128}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00025}{25}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a258bb72419ef143530a2f8f55e7d57af}\index{config.h@{config.h}!NO\_ERROR@{NO\_ERROR}}
|
|
\index{NO\_ERROR@{NO\_ERROR}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{NO\_ERROR}{NO\_ERROR}}
|
|
{\footnotesize\ttfamily \label{config_8h_a258bb72419ef143530a2f8f55e7d57af}
|
|
\#define NO\+\_\+\+ERROR~0}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00005}{5}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_ac1a724419200e9f961dc787950aecd2b}\index{config.h@{config.h}!NO\_SECTION@{NO\_SECTION}}
|
|
\index{NO\_SECTION@{NO\_SECTION}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{NO\_SECTION}{NO\_SECTION}}
|
|
{\footnotesize\ttfamily \label{config_8h_ac1a724419200e9f961dc787950aecd2b}
|
|
\#define NO\+\_\+\+SECTION~0}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00001}{1}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_ad89f5843f6a9cdc6a61d5af4734cd75d}\index{config.h@{config.h}!ST\_ERROR\_GETSTRATPOS@{ST\_ERROR\_GETSTRATPOS}}
|
|
\index{ST\_ERROR\_GETSTRATPOS@{ST\_ERROR\_GETSTRATPOS}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_ERROR\_GETSTRATPOS}{ST\_ERROR\_GETSTRATPOS}}
|
|
{\footnotesize\ttfamily \label{config_8h_ad89f5843f6a9cdc6a61d5af4734cd75d}
|
|
\#define ST\+\_\+\+ERROR\+\_\+\+GETSTRATPOS~30}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00022}{22}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_afae21c34cd1bfa910d95db50f151c81c}\index{config.h@{config.h}!ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER@{ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER}}
|
|
\index{ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER@{ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER}{ST\_ERROR\_NOT\_FOUND\_LEFT\_DELIMITER}}
|
|
{\footnotesize\ttfamily \label{config_8h_afae21c34cd1bfa910d95db50f151c81c}
|
|
\#define ST\+\_\+\+ERROR\+\_\+\+NOT\+\_\+\+FOUND\+\_\+\+LEFT\+\_\+\+DELIMITER~4}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00015}{15}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_aea1c2232d9f2837fbb565f13e5d7e8ea}\index{config.h@{config.h}!ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER@{ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER}}
|
|
\index{ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER@{ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER}{ST\_ERROR\_NOT\_FOUND\_RIGHT\_DELIMITER}}
|
|
{\footnotesize\ttfamily \label{config_8h_aea1c2232d9f2837fbb565f13e5d7e8ea}
|
|
\#define ST\+\_\+\+ERROR\+\_\+\+NOT\+\_\+\+FOUND\+\_\+\+RIGHT\+\_\+\+DELIMITER~3}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00014}{14}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a587e636e48ca212f7c964a93ae005e03}\index{config.h@{config.h}!ST\_FINISH@{ST\_FINISH}}
|
|
\index{ST\_FINISH@{ST\_FINISH}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_FINISH}{ST\_FINISH}}
|
|
{\footnotesize\ttfamily \label{config_8h_a587e636e48ca212f7c964a93ae005e03}
|
|
\#define ST\+\_\+\+FINISH~20}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00019}{19}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a4aa0fcd1d1c19c873711c0dbdf590f51}\index{config.h@{config.h}!ST\_FOUND\_LEFT\_DELIMITER@{ST\_FOUND\_LEFT\_DELIMITER}}
|
|
\index{ST\_FOUND\_LEFT\_DELIMITER@{ST\_FOUND\_LEFT\_DELIMITER}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_FOUND\_LEFT\_DELIMITER}{ST\_FOUND\_LEFT\_DELIMITER}}
|
|
{\footnotesize\ttfamily \label{config_8h_a4aa0fcd1d1c19c873711c0dbdf590f51}
|
|
\#define ST\+\_\+\+FOUND\+\_\+\+LEFT\+\_\+\+DELIMITER~1}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00012}{12}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a109ad3408cd20ac98f7063ad33ee151c}\index{config.h@{config.h}!ST\_FOUND\_RIGHT\_DELIMITER@{ST\_FOUND\_RIGHT\_DELIMITER}}
|
|
\index{ST\_FOUND\_RIGHT\_DELIMITER@{ST\_FOUND\_RIGHT\_DELIMITER}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_FOUND\_RIGHT\_DELIMITER}{ST\_FOUND\_RIGHT\_DELIMITER}}
|
|
{\footnotesize\ttfamily \label{config_8h_a109ad3408cd20ac98f7063ad33ee151c}
|
|
\#define ST\+\_\+\+FOUND\+\_\+\+RIGHT\+\_\+\+DELIMITER~2}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00013}{13}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a50f0255611b79622dbca5cf9c27b7f43}\index{config.h@{config.h}!ST\_FOUND\_SECTION@{ST\_FOUND\_SECTION}}
|
|
\index{ST\_FOUND\_SECTION@{ST\_FOUND\_SECTION}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_FOUND\_SECTION}{ST\_FOUND\_SECTION}}
|
|
{\footnotesize\ttfamily \label{config_8h_a50f0255611b79622dbca5cf9c27b7f43}
|
|
\#define ST\+\_\+\+FOUND\+\_\+\+SECTION~5}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00016}{16}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a07c5dd6a63f85102afff94734b066db6}\index{config.h@{config.h}!ST\_INIT@{ST\_INIT}}
|
|
\index{ST\_INIT@{ST\_INIT}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_INIT}{ST\_INIT}}
|
|
{\footnotesize\ttfamily \label{config_8h_a07c5dd6a63f85102afff94734b066db6}
|
|
\#define ST\+\_\+\+INIT~0}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00011}{11}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
\Hypertarget{config_8h_a71a276bab1ecc5d309fe1593a1640d5d}\index{config.h@{config.h}!ST\_SKIP\_READ@{ST\_SKIP\_READ}}
|
|
\index{ST\_SKIP\_READ@{ST\_SKIP\_READ}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{ST\_SKIP\_READ}{ST\_SKIP\_READ}}
|
|
{\footnotesize\ttfamily \label{config_8h_a71a276bab1ecc5d309fe1593a1640d5d}
|
|
\#define ST\+\_\+\+SKIP\+\_\+\+READ~6}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8h_source_l00017}{17}} of file \mbox{\hyperlink{config_8h_source}{config.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Function Documentation}
|
|
\Hypertarget{config_8h_aae86bc3f3ebba4d6aba3ca1392c0126a}\index{config.h@{config.h}!checkSection@{checkSection}}
|
|
\index{checkSection@{checkSection}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{checkSection()}{checkSection()}}
|
|
{\footnotesize\ttfamily \label{config_8h_aae86bc3f3ebba4d6aba3ca1392c0126a}
|
|
int check\+Section (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{str}{, }\item[{char}]{delimiter\+Left}{, }\item[{char}]{delimiter\+Right}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{section\+Name}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Here we check if the given string contains a section for example \mbox{[}SECTIONName\mbox{]} here delimiter\+Left is \mbox{[} and delimiter\+Right is \mbox{]} if a section is found, the section name will be written to section\+Name.
|
|
|
|
Input\+:
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em char} & \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}str\+: the string to check \\
|
|
\hline
|
|
{\em char} & delimiter\+Left\+: the left delimiter to check for \\
|
|
\hline
|
|
{\em char} & delimiter\+Right\+: the right delimiter to check for\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
Output\+:
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em char} & \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}section\+Name\+: if found the section Name of the section\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
Return\+:
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em int} & status\+\_\+code\+: one of the following values\+: \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_8c_source_l00024}{24}} of file \mbox{\hyperlink{config_8c_source}{config.\+c}}.
|
|
|
|
\Hypertarget{config_8h_ab0b547ee554d9b305adc1b2ad85080a3}\index{config.h@{config.h}!getNameValuePair@{getNameValuePair}}
|
|
\index{getNameValuePair@{getNameValuePair}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{getNameValuePair()}{getNameValuePair()}}
|
|
{\footnotesize\ttfamily \label{config_8h_ab0b547ee554d9b305adc1b2ad85080a3}
|
|
int get\+Name\+Value\+Pair (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{str}{, }\item[{char}]{left\+Delimiter\+Pos}{, }\item[{char}]{right\+Delimiter\+Pos}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{name}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{value}{, }\item[{int}]{size\+Name}{, }\item[{int}]{size\+Value}{}\end{DoxyParamCaption})}
|
|
|
|
Here we get a "{}pair"{} of data, parsed from \texorpdfstring{$\ast$}{*}str, witch consists of a keyname and a keyvalue. These are written to the pointers at char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name and char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}value. These pair can be in the form of\+: ex1\+: NAME=VALUE \texorpdfstring{$^\wedge$}{\string^} \texorpdfstring{$^\wedge$}{\string^} \texorpdfstring{$\vert$}{|} Here we have no delimiter this means right\+Delimiter\+Pos must be NULL This is the left delimiter ex2\+: name(value) \texorpdfstring{$^\wedge$}{\string^} \texorpdfstring{$^\wedge$}{\string^} \texorpdfstring{$\vert$}{|} This is the right\+Delimiter\+Pos and must be \textquotesingle{})\textquotesingle{} This is left\+Delimiter\+Pos which must be \textquotesingle{}(\textquotesingle{}
|
|
|
|
Input\+: char \texorpdfstring{$\ast$}{*}str\+: the line in the form of a string where a key value pair is stored char left\+Delimiter\+Pos\+: the left delimiter for example \textquotesingle{}=\textquotesingle{} char right\+Delimiter\+Pos\+: the right delimiter can be NULL in most cases, if NULL we assume that there is only one delimiter, which is in this case the left\+Delimiter\+Pos Output\+: char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name\+: The address where we store the name of the Key char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}value\+: The address where we store the key value int size\+Name\+: for size checking against memory allocated at \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name int size\+Value\+: for size checking against memory allocated at \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}value
|
|
|
|
Return\+: will return NO\+\_\+\+ERROR (0) if successfull. If not it will return the error of the subroutine
|
|
|
|
Definition at line \mbox{\hyperlink{config_8c_source_l00151}{151}} of file \mbox{\hyperlink{config_8c_source}{config.\+c}}.
|
|
|
|
\Hypertarget{config_8h_a699e504c1ab9ceffb828dbf365a5e374}\index{config.h@{config.h}!getStrAtPos@{getStrAtPos}}
|
|
\index{getStrAtPos@{getStrAtPos}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{getStrAtPos()}{getStrAtPos()}}
|
|
{\footnotesize\ttfamily \label{config_8h_a699e504c1ab9ceffb828dbf365a5e374}
|
|
int get\+Str\+At\+Pos (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{str}{, }\item[{int}]{from\+Pos}{, }\item[{int}]{to\+Pos}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{name}{, }\item[{int}]{size\+Name}{}\end{DoxyParamCaption})}
|
|
|
|
Here we get / cut from from\+Pos to to\+Pos and write it to an address
|
|
|
|
Input\+: char \texorpdfstring{$\ast$}{*}str\+: the string to cut int from\+Pos\+: from which position we want to copy, the pos is included and zero indexed int to\+Pos\+: to which position we want to copy, the pos is included and zero indexed Output\+: char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name\+: here we will write the section name to Input\+: int size\+Name\+: the size of the user allocated buffer at \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}name
|
|
|
|
Definition at line \mbox{\hyperlink{config_8c_source_l00098}{98}} of file \mbox{\hyperlink{config_8c_source}{config.\+c}}.
|
|
|
|
\Hypertarget{config_8h_acbd35a1e4b5f0eea312f8cb64f898d4b}\index{config.h@{config.h}!loadConfig@{loadConfig}}
|
|
\index{loadConfig@{loadConfig}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{loadConfig()}{loadConfig()}}
|
|
{\footnotesize\ttfamily \label{config_8h_acbd35a1e4b5f0eea312f8cb64f898d4b}
|
|
int load\+Config (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{file}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{str\+\_\+entry}{, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{host}{, }\item[{int \texorpdfstring{$\ast$}{*}}]{intervall}{, }\item[{int}]{size}{}\end{DoxyParamCaption})}
|
|
|
|
\Hypertarget{config_8h_aa8a964c95239ab762c37713f5f53a583}\index{config.h@{config.h}!parseConfig@{parseConfig}}
|
|
\index{parseConfig@{parseConfig}!config.h@{config.h}}
|
|
\doxysubsubsection{\texorpdfstring{parseConfig()}{parseConfig()}}
|
|
{\footnotesize\ttfamily \label{config_8h_aa8a964c95239ab762c37713f5f53a583}
|
|
int parse\+Config (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{original\+Buffer}{, }\item[{struct \mbox{\hyperlink{structconfigEntry}{config\+Entry}} \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{entry}{, }\item[{int}]{config\+Size\+Count}{, }\item[{int \texorpdfstring{$\ast$}{*}}]{returned\+Count}{}\end{DoxyParamCaption})}
|
|
|
|
Given a null terminated buffer of content(ex. from a file) an parse it with a default syntax of\+: Sections -\/\texorpdfstring{$>$}{>} \mbox{[}SECTIONNAME\mbox{]} name / value -\/\texorpdfstring{$>$}{>} name=value
|
|
|
|
Input\+: char \texorpdfstring{$\ast$}{*}original\+Buffer\+: the buffer which holds the string for parsing. struct \doxylink{structconfigEntry}{config\+Entry} \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}entry\+: a user allocated buffer to which we write the parsed config data. int config\+Size\+Count\+: the user allocated size of \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}entry. Output\+: int \texorpdfstring{$\ast$}{*}returned\+Count\+: to this variable the function writes the count of struct, which will be required to store all alavaible data.
|
|
|
|
Note\+: The funtion returns the maximum allowed data structures, determined by config\+Size\+Count. All data which exceeds will be dropped. To get the whole data we run the funtion a second time with the realloced config\+Size\+Count in the size of \mbox{[}returned\+Count\mbox{]} structures.
|
|
|
|
Definition at line \mbox{\hyperlink{config_8c_source_l00215}{215}} of file \mbox{\hyperlink{config_8c_source}{config.\+c}}.
|
|
|