725 lines
39 KiB
HTML
725 lines
39 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>config-parser: config.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">config-parser
|
|
</div>
|
|
<div id="projectbrief">a simple ini parser written in C</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('config_8h.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">config.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="config_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structconfigEntry.html">configEntry</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ac1a724419200e9f961dc787950aecd2b" id="r_ac1a724419200e9f961dc787950aecd2b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1a724419200e9f961dc787950aecd2b">NO_SECTION</a>   0</td></tr>
|
|
<tr class="separator:ac1a724419200e9f961dc787950aecd2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02f5a0519bc0372946e64d593c0c58ce" id="r_a02f5a0519bc0372946e64d593c0c58ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a02f5a0519bc0372946e64d593c0c58ce">FOUND_SECTION</a>   10</td></tr>
|
|
<tr class="separator:a02f5a0519bc0372946e64d593c0c58ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc212059095802b47f10a6a49fd45abc" id="r_abc212059095802b47f10a6a49fd45abc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc212059095802b47f10a6a49fd45abc">ERROR_STR</a>   1001</td></tr>
|
|
<tr class="separator:abc212059095802b47f10a6a49fd45abc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39de51bdb6918a63eac8b1bb474e2b84" id="r_a39de51bdb6918a63eac8b1bb474e2b84"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a39de51bdb6918a63eac8b1bb474e2b84">ERROR_MAX_LEN</a>   2</td></tr>
|
|
<tr class="separator:a39de51bdb6918a63eac8b1bb474e2b84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a258bb72419ef143530a2f8f55e7d57af" id="r_a258bb72419ef143530a2f8f55e7d57af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a258bb72419ef143530a2f8f55e7d57af">NO_ERROR</a>   0</td></tr>
|
|
<tr class="separator:a258bb72419ef143530a2f8f55e7d57af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0000658c96c7c74c0904aafe03429a7d" id="r_a0000658c96c7c74c0904aafe03429a7d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0000658c96c7c74c0904aafe03429a7d">ERROR_DELIMITER_NOT_FOUND</a>   40</td></tr>
|
|
<tr class="separator:a0000658c96c7c74c0904aafe03429a7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07c5dd6a63f85102afff94734b066db6" id="r_a07c5dd6a63f85102afff94734b066db6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a07c5dd6a63f85102afff94734b066db6">ST_INIT</a>   0</td></tr>
|
|
<tr class="separator:a07c5dd6a63f85102afff94734b066db6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4aa0fcd1d1c19c873711c0dbdf590f51" id="r_a4aa0fcd1d1c19c873711c0dbdf590f51"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4aa0fcd1d1c19c873711c0dbdf590f51">ST_FOUND_LEFT_DELIMITER</a>   1</td></tr>
|
|
<tr class="separator:a4aa0fcd1d1c19c873711c0dbdf590f51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a109ad3408cd20ac98f7063ad33ee151c" id="r_a109ad3408cd20ac98f7063ad33ee151c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a109ad3408cd20ac98f7063ad33ee151c">ST_FOUND_RIGHT_DELIMITER</a>   2</td></tr>
|
|
<tr class="separator:a109ad3408cd20ac98f7063ad33ee151c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea1c2232d9f2837fbb565f13e5d7e8ea" id="r_aea1c2232d9f2837fbb565f13e5d7e8ea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea1c2232d9f2837fbb565f13e5d7e8ea">ST_ERROR_NOT_FOUND_RIGHT_DELIMITER</a>   3</td></tr>
|
|
<tr class="separator:aea1c2232d9f2837fbb565f13e5d7e8ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afae21c34cd1bfa910d95db50f151c81c" id="r_afae21c34cd1bfa910d95db50f151c81c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#afae21c34cd1bfa910d95db50f151c81c">ST_ERROR_NOT_FOUND_LEFT_DELIMITER</a>   4</td></tr>
|
|
<tr class="separator:afae21c34cd1bfa910d95db50f151c81c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50f0255611b79622dbca5cf9c27b7f43" id="r_a50f0255611b79622dbca5cf9c27b7f43"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a50f0255611b79622dbca5cf9c27b7f43">ST_FOUND_SECTION</a>   5</td></tr>
|
|
<tr class="separator:a50f0255611b79622dbca5cf9c27b7f43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71a276bab1ecc5d309fe1593a1640d5d" id="r_a71a276bab1ecc5d309fe1593a1640d5d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a71a276bab1ecc5d309fe1593a1640d5d">ST_SKIP_READ</a>   6</td></tr>
|
|
<tr class="separator:a71a276bab1ecc5d309fe1593a1640d5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a587e636e48ca212f7c964a93ae005e03" id="r_a587e636e48ca212f7c964a93ae005e03"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a587e636e48ca212f7c964a93ae005e03">ST_FINISH</a>   20</td></tr>
|
|
<tr class="separator:a587e636e48ca212f7c964a93ae005e03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad89f5843f6a9cdc6a61d5af4734cd75d" id="r_ad89f5843f6a9cdc6a61d5af4734cd75d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad89f5843f6a9cdc6a61d5af4734cd75d">ST_ERROR_GETSTRATPOS</a>   30</td></tr>
|
|
<tr class="separator:ad89f5843f6a9cdc6a61d5af4734cd75d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa454692b60895f7025f12b1e0065acea" id="r_aa454692b60895f7025f12b1e0065acea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa454692b60895f7025f12b1e0065acea">MAX_LEN_SECTIONNAME</a>   128</td></tr>
|
|
<tr class="separator:aa454692b60895f7025f12b1e0065acea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0f18393ca3f7c151a4e58ae35b119f7" id="r_ae0f18393ca3f7c151a4e58ae35b119f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0f18393ca3f7c151a4e58ae35b119f7">ERR_PARSECONFIG_UNKNOWN</a>   201</td></tr>
|
|
<tr class="separator:ae0f18393ca3f7c151a4e58ae35b119f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:acbd35a1e4b5f0eea312f8cb64f898d4b" id="r_acbd35a1e4b5f0eea312f8cb64f898d4b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#acbd35a1e4b5f0eea312f8cb64f898d4b">loadConfig</a> (char *file, char **str_entry, char **host, int *intervall, int size)</td></tr>
|
|
<tr class="separator:acbd35a1e4b5f0eea312f8cb64f898d4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae86bc3f3ebba4d6aba3ca1392c0126a" id="r_aae86bc3f3ebba4d6aba3ca1392c0126a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aae86bc3f3ebba4d6aba3ca1392c0126a">checkSection</a> (char *str, char delimiterLeft, char delimiterRight, char **sectionName)</td></tr>
|
|
<tr class="memdesc:aae86bc3f3ebba4d6aba3ca1392c0126a"><td class="mdescLeft"> </td><td class="mdescRight">Here we check if the given string contains a section for example [SECTIONName] here delimiterLeft is [ and delimiterRight is ] if a section is found, the section name will be written to sectionName. <br /></td></tr>
|
|
<tr class="separator:aae86bc3f3ebba4d6aba3ca1392c0126a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a699e504c1ab9ceffb828dbf365a5e374" id="r_a699e504c1ab9ceffb828dbf365a5e374"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a699e504c1ab9ceffb828dbf365a5e374">getStrAtPos</a> (char *str, int fromPos, int toPos, char **name, int sizeName)</td></tr>
|
|
<tr class="memdesc:a699e504c1ab9ceffb828dbf365a5e374"><td class="mdescLeft"> </td><td class="mdescRight">Here we get / cut from fromPos to toPos and write it to an address. <br /></td></tr>
|
|
<tr class="separator:a699e504c1ab9ceffb828dbf365a5e374"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0b547ee554d9b305adc1b2ad85080a3" id="r_ab0b547ee554d9b305adc1b2ad85080a3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0b547ee554d9b305adc1b2ad85080a3">getNameValuePair</a> (char *str, char leftDelimiterPos, char rightDelimiterPos, char **name, char **value, int sizeName, int sizeValue)</td></tr>
|
|
<tr class="memdesc:ab0b547ee554d9b305adc1b2ad85080a3"><td class="mdescLeft"> </td><td class="mdescRight">Input: <br /></td></tr>
|
|
<tr class="separator:ab0b547ee554d9b305adc1b2ad85080a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8a964c95239ab762c37713f5f53a583" id="r_aa8a964c95239ab762c37713f5f53a583"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8a964c95239ab762c37713f5f53a583">parseConfig</a> (char *buffer, struct <a class="el" href="structconfigEntry.html">configEntry</a> **entry, int configSize, int *returnedCount)</td></tr>
|
|
<tr class="separator:aa8a964c95239ab762c37713f5f53a583"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ae0f18393ca3f7c151a4e58ae35b119f7" name="ae0f18393ca3f7c151a4e58ae35b119f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0f18393ca3f7c151a4e58ae35b119f7">◆ </a></span>ERR_PARSECONFIG_UNKNOWN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ERR_PARSECONFIG_UNKNOWN   201</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00028">28</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0000658c96c7c74c0904aafe03429a7d" name="a0000658c96c7c74c0904aafe03429a7d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0000658c96c7c74c0904aafe03429a7d">◆ </a></span>ERROR_DELIMITER_NOT_FOUND</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ERROR_DELIMITER_NOT_FOUND   40</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00007">7</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39de51bdb6918a63eac8b1bb474e2b84" name="a39de51bdb6918a63eac8b1bb474e2b84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39de51bdb6918a63eac8b1bb474e2b84">◆ </a></span>ERROR_MAX_LEN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ERROR_MAX_LEN   2</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00004">4</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc212059095802b47f10a6a49fd45abc" name="abc212059095802b47f10a6a49fd45abc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc212059095802b47f10a6a49fd45abc">◆ </a></span>ERROR_STR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ERROR_STR   1001</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00003">3</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02f5a0519bc0372946e64d593c0c58ce" name="a02f5a0519bc0372946e64d593c0c58ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02f5a0519bc0372946e64d593c0c58ce">◆ </a></span>FOUND_SECTION</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FOUND_SECTION   10</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00002">2</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa454692b60895f7025f12b1e0065acea" name="aa454692b60895f7025f12b1e0065acea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa454692b60895f7025f12b1e0065acea">◆ </a></span>MAX_LEN_SECTIONNAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MAX_LEN_SECTIONNAME   128</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00025">25</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a258bb72419ef143530a2f8f55e7d57af" name="a258bb72419ef143530a2f8f55e7d57af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a258bb72419ef143530a2f8f55e7d57af">◆ </a></span>NO_ERROR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define NO_ERROR   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00005">5</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1a724419200e9f961dc787950aecd2b" name="ac1a724419200e9f961dc787950aecd2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1a724419200e9f961dc787950aecd2b">◆ </a></span>NO_SECTION</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define NO_SECTION   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00001">1</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad89f5843f6a9cdc6a61d5af4734cd75d" name="ad89f5843f6a9cdc6a61d5af4734cd75d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad89f5843f6a9cdc6a61d5af4734cd75d">◆ </a></span>ST_ERROR_GETSTRATPOS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_ERROR_GETSTRATPOS   30</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00022">22</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afae21c34cd1bfa910d95db50f151c81c" name="afae21c34cd1bfa910d95db50f151c81c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afae21c34cd1bfa910d95db50f151c81c">◆ </a></span>ST_ERROR_NOT_FOUND_LEFT_DELIMITER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_ERROR_NOT_FOUND_LEFT_DELIMITER   4</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00015">15</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea1c2232d9f2837fbb565f13e5d7e8ea" name="aea1c2232d9f2837fbb565f13e5d7e8ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea1c2232d9f2837fbb565f13e5d7e8ea">◆ </a></span>ST_ERROR_NOT_FOUND_RIGHT_DELIMITER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_ERROR_NOT_FOUND_RIGHT_DELIMITER   3</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00014">14</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a587e636e48ca212f7c964a93ae005e03" name="a587e636e48ca212f7c964a93ae005e03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a587e636e48ca212f7c964a93ae005e03">◆ </a></span>ST_FINISH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_FINISH   20</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00019">19</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4aa0fcd1d1c19c873711c0dbdf590f51" name="a4aa0fcd1d1c19c873711c0dbdf590f51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4aa0fcd1d1c19c873711c0dbdf590f51">◆ </a></span>ST_FOUND_LEFT_DELIMITER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_FOUND_LEFT_DELIMITER   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00012">12</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a109ad3408cd20ac98f7063ad33ee151c" name="a109ad3408cd20ac98f7063ad33ee151c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a109ad3408cd20ac98f7063ad33ee151c">◆ </a></span>ST_FOUND_RIGHT_DELIMITER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_FOUND_RIGHT_DELIMITER   2</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00013">13</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50f0255611b79622dbca5cf9c27b7f43" name="a50f0255611b79622dbca5cf9c27b7f43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50f0255611b79622dbca5cf9c27b7f43">◆ </a></span>ST_FOUND_SECTION</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_FOUND_SECTION   5</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00016">16</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07c5dd6a63f85102afff94734b066db6" name="a07c5dd6a63f85102afff94734b066db6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07c5dd6a63f85102afff94734b066db6">◆ </a></span>ST_INIT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_INIT   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00011">11</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a71a276bab1ecc5d309fe1593a1640d5d" name="a71a276bab1ecc5d309fe1593a1640d5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71a276bab1ecc5d309fe1593a1640d5d">◆ </a></span>ST_SKIP_READ</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ST_SKIP_READ   6</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00017">17</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aae86bc3f3ebba4d6aba3ca1392c0126a" name="aae86bc3f3ebba4d6aba3ca1392c0126a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae86bc3f3ebba4d6aba3ca1392c0126a">◆ </a></span>checkSection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int checkSection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>delimiterLeft</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>delimiterRight</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>sectionName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Here we check if the given string contains a section for example [SECTIONName] here delimiterLeft is [ and delimiterRight is ] if a section is found, the section name will be written to sectionName. </p>
|
|
<p>Input: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>**str: the string to check </td></tr>
|
|
<tr><td class="paramname">char</td><td>delimiterLeft: the left delimiter to check for </td></tr>
|
|
<tr><td class="paramname">char</td><td>delimiterRight: the right delimiter to check for</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Output: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>**sectionName: if found the section Name of the section</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Return: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">int</td><td>status_code: one of the following values: </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00024">24</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0b547ee554d9b305adc1b2ad85080a3" name="ab0b547ee554d9b305adc1b2ad85080a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0b547ee554d9b305adc1b2ad85080a3">◆ </a></span>getNameValuePair()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int getNameValuePair </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>leftDelimiterPos</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>rightDelimiterPos</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>sizeName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>sizeValue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Input: </p>
|
|
<p>Here we get a "pair" of data, parsed from *str, witch consists of a keyname and a keyvalue. These are written to the pointers at char **name and char **value. These pair can be in the form of: <br />
|
|
ex1: <br />
|
|
NAME=VALUE <br />
|
|
____^_____^ <br />
|
|
____|_____Here we have no delimiter this means rightDelimiterPos must be NULL <br />
|
|
____This is the left delimiter <br />
|
|
ex2: <br />
|
|
name(value) <br />
|
|
____^_____^ <br />
|
|
____|_____This is the rightDelimiterPos and must be ')' <br />
|
|
____This is leftDelimiterPos which must be '(' <br />
|
|
</p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>*str: the line in the form of a string where a key value pair is stored </td></tr>
|
|
<tr><td class="paramname">char</td><td>leftDelimiterPos: the left delimiter for example '=' </td></tr>
|
|
<tr><td class="paramname">char</td><td>rightDelimiterPos: 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 leftDelimiterPos</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Output: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>**name: The address where we store the name of the Key </td></tr>
|
|
<tr><td class="paramname">char</td><td>**value: The address where we store the key value </td></tr>
|
|
<tr><td class="paramname">int</td><td>sizeName: for size checking against memory allocated at **name </td></tr>
|
|
<tr><td class="paramname">int</td><td>sizeValue: for size checking against memory allocated at **value</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Return: </p><dl class="section return"><dt>Returns</dt><dd>will return NO_ERROR (0) if successfull. If not it will return the error of the subroutine </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00151">151</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a699e504c1ab9ceffb828dbf365a5e374" name="a699e504c1ab9ceffb828dbf365a5e374"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a699e504c1ab9ceffb828dbf365a5e374">◆ </a></span>getStrAtPos()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int getStrAtPos </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>fromPos</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>toPos</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>sizeName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Here we get / cut from fromPos to toPos and write it to an address. </p>
|
|
<p>Input: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>*str: the string to cut </td></tr>
|
|
<tr><td class="paramname">int</td><td>fromPos: from which position we want to copy, the pos is included and zero indexed </td></tr>
|
|
<tr><td class="paramname">int</td><td>toPos: to which position we want to copy, the pos is included and zero indexed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Output: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">char</td><td>**name: here we will write the section name to</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Input: </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">int</td><td>sizeName: the size of the user allocated buffer at **name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00098">98</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acbd35a1e4b5f0eea312f8cb64f898d4b" name="acbd35a1e4b5f0eea312f8cb64f898d4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbd35a1e4b5f0eea312f8cb64f898d4b">◆ </a></span>loadConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int loadConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>str_entry</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>host</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>intervall</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa8a964c95239ab762c37713f5f53a583" name="aa8a964c95239ab762c37713f5f53a583"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8a964c95239ab762c37713f5f53a583">◆ </a></span>parseConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int parseConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>originalBuffer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">struct <a class="el" href="structconfigEntry.html">configEntry</a> **</td> <td class="paramname"><span class="paramname"><em>entry</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>configSizeCount</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>returnedCount</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Given a null terminated buffer of content(ex. from a file) an parse it with a default syntax of: Sections -> [SECTIONNAME] name / value -> name=value</p>
|
|
<p>Input: char *originalBuffer: the buffer which holds the string for parsing. struct <a class="el" href="structconfigEntry.html">configEntry</a> **entry: a user allocated buffer to which we write the parsed config data. int configSizeCount: the user allocated size of **entry. Output: int *returnedCount: to this variable the function writes the count of struct, which will be required to store all alavaible data.</p>
|
|
<p>Note: The funtion returns the maximum allowed data structures, determined by configSizeCount. All data which exceeds will be dropped. To get the whole data we run the funtion a second time with the realloced configSizeCount in the size of [returnedCount] structures. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00215">215</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="config_8h.html">config.h</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|