<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libini_config: Value management</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>
<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">
$(document).ready(function() { init_search(); });
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libini_config
 <span id="projectnumber">0.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Value management</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaab7f2ce07b399e15ead974fb4e3c7e77"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj</a> (const char *section, const char *name, struct ini_cfgobj *ini_config, int mode, struct value_obj **vo)</td></tr>
<tr class="memdesc:gaab7f2ce07b399e15ead974fb4e3c7e77"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a value object form the configuration. <a href="#gaab7f2ce07b399e15ead974fb4e3c7e77">More...</a><br /></td></tr>
<tr class="separator:gaab7f2ce07b399e15ead974fb4e3c7e77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0430c972de1b12c64753a1b2b5f3e35"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gaf0430c972de1b12c64753a1b2b5f3e35">ini_get_int_config_value</a> (struct value_obj *vo, int strict, int def, int *error)</td></tr>
<tr class="memdesc:gaf0430c972de1b12c64753a1b2b5f3e35"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to integer number. <a href="#gaf0430c972de1b12c64753a1b2b5f3e35">More...</a><br /></td></tr>
<tr class="separator:gaf0430c972de1b12c64753a1b2b5f3e35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga352ad6196333d635e6b343c8c4d7de1e"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga352ad6196333d635e6b343c8c4d7de1e">ini_get_unsigned_config_value</a> (struct value_obj *vo, int strict, unsigned def, int *error)</td></tr>
<tr class="memdesc:ga352ad6196333d635e6b343c8c4d7de1e"><td class="mdescLeft"> </td><td class="mdescRight">Convert value object to a unsigned number. <a href="#ga352ad6196333d635e6b343c8c4d7de1e">More...</a><br /></td></tr>
<tr class="separator:ga352ad6196333d635e6b343c8c4d7de1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabed4c4bb09b17a7395680aa414f67197"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gabed4c4bb09b17a7395680aa414f67197">ini_get_long_config_value</a> (struct value_obj *vo, int strict, long def, int *error)</td></tr>
<tr class="memdesc:gabed4c4bb09b17a7395680aa414f67197"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to long number. <a href="#gabed4c4bb09b17a7395680aa414f67197">More...</a><br /></td></tr>
<tr class="separator:gabed4c4bb09b17a7395680aa414f67197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga190a2c43006d49c29b581c71f6778401"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga190a2c43006d49c29b581c71f6778401">ini_get_ulong_config_value</a> (struct value_obj *vo, int strict, unsigned long def, int *error)</td></tr>
<tr class="memdesc:ga190a2c43006d49c29b581c71f6778401"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to unsigned long number. <a href="#ga190a2c43006d49c29b581c71f6778401">More...</a><br /></td></tr>
<tr class="separator:ga190a2c43006d49c29b581c71f6778401"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c188d60d512de81d8d259c992c5699a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga5c188d60d512de81d8d259c992c5699a">ini_get_int32_config_value</a> (struct value_obj *vo, int strict, int32_t def, int *error)</td></tr>
<tr class="memdesc:ga5c188d60d512de81d8d259c992c5699a"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to int32_t number. <a href="#ga5c188d60d512de81d8d259c992c5699a">More...</a><br /></td></tr>
<tr class="separator:ga5c188d60d512de81d8d259c992c5699a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8f216bd2372cfdba1eb98b61ea894d3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gad8f216bd2372cfdba1eb98b61ea894d3">ini_get_uint32_config_value</a> (struct value_obj *vo, int strict, uint32_t def, int *error)</td></tr>
<tr class="memdesc:gad8f216bd2372cfdba1eb98b61ea894d3"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to uint32_t number. <a href="#gad8f216bd2372cfdba1eb98b61ea894d3">More...</a><br /></td></tr>
<tr class="separator:gad8f216bd2372cfdba1eb98b61ea894d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0add5d81a8b9a4ae902c2e2100588c4e"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga0add5d81a8b9a4ae902c2e2100588c4e">ini_get_int64_config_value</a> (struct value_obj *vo, int strict, int64_t def, int *error)</td></tr>
<tr class="memdesc:ga0add5d81a8b9a4ae902c2e2100588c4e"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to integer number. <a href="#ga0add5d81a8b9a4ae902c2e2100588c4e">More...</a><br /></td></tr>
<tr class="separator:ga0add5d81a8b9a4ae902c2e2100588c4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa29d3253946f1b2140eb4ea4f3c66c93"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gaa29d3253946f1b2140eb4ea4f3c66c93">ini_get_uint64_config_value</a> (struct value_obj *vo, int strict, uint64_t def, int *error)</td></tr>
<tr class="memdesc:gaa29d3253946f1b2140eb4ea4f3c66c93"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to integer number. <a href="#gaa29d3253946f1b2140eb4ea4f3c66c93">More...</a><br /></td></tr>
<tr class="separator:gaa29d3253946f1b2140eb4ea4f3c66c93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b94f88e09ec76033aebfb06be384a8a"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga2b94f88e09ec76033aebfb06be384a8a">ini_get_double_config_value</a> (struct value_obj *vo, int strict, double def, int *error)</td></tr>
<tr class="memdesc:ga2b94f88e09ec76033aebfb06be384a8a"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to floating point number. <a href="#ga2b94f88e09ec76033aebfb06be384a8a">More...</a><br /></td></tr>
<tr class="separator:ga2b94f88e09ec76033aebfb06be384a8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga28d539fe8e205087de9a693460cdb918"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga28d539fe8e205087de9a693460cdb918">ini_get_bool_config_value</a> (struct value_obj *vo, unsigned char def, int *error)</td></tr>
<tr class="memdesc:ga28d539fe8e205087de9a693460cdb918"><td class="mdescLeft"> </td><td class="mdescRight">Convert value into a logical value. <a href="#ga28d539fe8e205087de9a693460cdb918">More...</a><br /></td></tr>
<tr class="separator:ga28d539fe8e205087de9a693460cdb918"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e3de518b496dc65276ec91956f1b267"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga0e3de518b496dc65276ec91956f1b267">ini_get_string_config_value</a> (struct value_obj *vo, int *error)</td></tr>
<tr class="memdesc:ga0e3de518b496dc65276ec91956f1b267"><td class="mdescLeft"> </td><td class="mdescRight">Get the copy of string stored in the configuration value. <a href="#ga0e3de518b496dc65276ec91956f1b267">More...</a><br /></td></tr>
<tr class="separator:ga0e3de518b496dc65276ec91956f1b267"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga153ba9ffddfa4f47ab785d09fa8af4aa"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga153ba9ffddfa4f47ab785d09fa8af4aa">ini_get_const_string_config_value</a> (struct value_obj *vo, int *error)</td></tr>
<tr class="memdesc:ga153ba9ffddfa4f47ab785d09fa8af4aa"><td class="mdescLeft"> </td><td class="mdescRight">Get the string stored in the configuration value. <a href="#ga153ba9ffddfa4f47ab785d09fa8af4aa">More...</a><br /></td></tr>
<tr class="separator:ga153ba9ffddfa4f47ab785d09fa8af4aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga723e97bb34fb761f843315d769757500"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga723e97bb34fb761f843315d769757500">ini_get_bin_config_value</a> (struct value_obj *vo, int *length, int *error)</td></tr>
<tr class="memdesc:ga723e97bb34fb761f843315d769757500"><td class="mdescLeft"> </td><td class="mdescRight">Convert value into a binary sequence. <a href="#ga723e97bb34fb761f843315d769757500">More...</a><br /></td></tr>
<tr class="separator:ga723e97bb34fb761f843315d769757500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc445f98e43dce6a34b19760a9b67d7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gadc445f98e43dce6a34b19760a9b67d7c">ini_free_bin_config_value</a> (char *bin)</td></tr>
<tr class="memdesc:gadc445f98e43dce6a34b19760a9b67d7c"><td class="mdescLeft"> </td><td class="mdescRight">Free binary buffer. <a href="#gadc445f98e43dce6a34b19760a9b67d7c">More...</a><br /></td></tr>
<tr class="separator:gadc445f98e43dce6a34b19760a9b67d7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e08bd7d0db358450ff0cef6ba03790d"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga8e08bd7d0db358450ff0cef6ba03790d">ini_get_string_config_array</a> (struct value_obj *vo, const char *sep, int *size, int *error)</td></tr>
<tr class="memdesc:ga8e08bd7d0db358450ff0cef6ba03790d"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to an array of strings. <a href="#ga8e08bd7d0db358450ff0cef6ba03790d">More...</a><br /></td></tr>
<tr class="separator:ga8e08bd7d0db358450ff0cef6ba03790d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga72cc367e41127f2da94eb287751c9967"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga72cc367e41127f2da94eb287751c9967">ini_get_raw_string_config_array</a> (struct value_obj *vo, const char *sep, int *size, int *error)</td></tr>
<tr class="memdesc:ga72cc367e41127f2da94eb287751c9967"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to an array of strings. <a href="#ga72cc367e41127f2da94eb287751c9967">More...</a><br /></td></tr>
<tr class="separator:ga72cc367e41127f2da94eb287751c9967"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2503ecce2f57aef7e456e3dbbc5c92c0"><td class="memItemLeft" align="right" valign="top">long * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga2503ecce2f57aef7e456e3dbbc5c92c0">ini_get_long_config_array</a> (struct value_obj *vo, int *size, int *error)</td></tr>
<tr class="memdesc:ga2503ecce2f57aef7e456e3dbbc5c92c0"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to an array of long values. <a href="#ga2503ecce2f57aef7e456e3dbbc5c92c0">More...</a><br /></td></tr>
<tr class="separator:ga2503ecce2f57aef7e456e3dbbc5c92c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1da3ee561958674017ea2a92048b26fc"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#ga1da3ee561958674017ea2a92048b26fc">ini_get_double_config_array</a> (struct value_obj *vo, int *size, int *error)</td></tr>
<tr class="memdesc:ga1da3ee561958674017ea2a92048b26fc"><td class="mdescLeft"> </td><td class="mdescRight">Convert value to an array of floating point values. <a href="#ga1da3ee561958674017ea2a92048b26fc">More...</a><br /></td></tr>
<tr class="separator:ga1da3ee561958674017ea2a92048b26fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaab4950b1dbc28fe9ad9f7f92e6f45f8b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gaab4950b1dbc28fe9ad9f7f92e6f45f8b">ini_free_string_config_array</a> (char **str_config)</td></tr>
<tr class="memdesc:gaab4950b1dbc28fe9ad9f7f92e6f45f8b"><td class="mdescLeft"> </td><td class="mdescRight">Free array of string values. <a href="#gaab4950b1dbc28fe9ad9f7f92e6f45f8b">More...</a><br /></td></tr>
<tr class="separator:gaab4950b1dbc28fe9ad9f7f92e6f45f8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad083fe1029c5925d80e7f1496ae07d64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gad083fe1029c5925d80e7f1496ae07d64">ini_free_long_config_array</a> (long *array)</td></tr>
<tr class="memdesc:gad083fe1029c5925d80e7f1496ae07d64"><td class="mdescLeft"> </td><td class="mdescRight">Free array of long values. <a href="#gad083fe1029c5925d80e7f1496ae07d64">More...</a><br /></td></tr>
<tr class="separator:gad083fe1029c5925d80e7f1496ae07d64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab27eadd9eb32994711063b43c81f528a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__value.html#gab27eadd9eb32994711063b43c81f528a">ini_free_double_config_array</a> (double *array)</td></tr>
<tr class="memdesc:gab27eadd9eb32994711063b43c81f528a"><td class="mdescLeft"> </td><td class="mdescRight">Free array of floating pointer values. <a href="#gab27eadd9eb32994711063b43c81f528a">More...</a><br /></td></tr>
<tr class="separator:gab27eadd9eb32994711063b43c81f528a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This section contains value management functions. These functions can be used to interpret values that are stored in the configuration object in memory. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaab7f2ce07b399e15ead974fb4e3c7e77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ini_get_config_valueobj </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct ini_cfgobj * </td>
<td class="paramname"><em>ini_config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct value_obj ** </td>
<td class="paramname"><em>vo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a value object form the configuration. </p>
<p>Check return error code first. If the function returns an error there is a serious problem. Then check if object is found. Function will set vo parameter to NULL if no attribute with provided name is found in the collection.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">section</td><td>Section name. If NULL assumed default. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Attribute name to find. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ini_config</td><td>Configuration object to search. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>See <a class="el" href="group__searchmode.html">search mode</a> section for more info. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">vo</td><td>Value object. Will be set to NULL if element with the given name is not found. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 - Success. </dd>
<dd>
EINVAL - Invalid parameter. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf0430c972de1b12c64753a1b2b5f3e35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ini_get_int_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to integer number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an int number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from INT_MIN to INT_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga352ad6196333d635e6b343c8c4d7de1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ini_get_unsigned_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value object to a unsigned number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an unsigned number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from 0 to UINT_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="gabed4c4bb09b17a7395680aa414f67197"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long ini_get_long_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to long number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into a long number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from LONG_MIN to LONG_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga190a2c43006d49c29b581c71f6778401"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long ini_get_ulong_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to unsigned long number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an unsigned long number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from 0 to ULONG_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5c188d60d512de81d8d259c992c5699a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ini_get_int32_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to int32_t number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an int32_t number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from INT_MIN to INT_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="gad8f216bd2372cfdba1eb98b61ea894d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ini_get_uint32_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to uint32_t number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration value into an uint32_t number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from 0 to ULONG_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0add5d81a8b9a4ae902c2e2100588c4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t ini_get_int64_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to integer number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an int64_t number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from LLONG_MIN to LLONG_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa29d3253946f1b2140eb4ea4f3c66c93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t ini_get_uint64_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to integer number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an uint64_t number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit. The value range is from 0 to ULLONG_MAX.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ERANGE - Value is out of range.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2b94f88e09ec76033aebfb06be384a8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ini_get_double_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to floating point number. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into a floating point number. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value. If "strict" parameter is non zero the function will fail if there are more characters after the last digit.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>Fail the function if the symbol after last digit is not valid. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga28d539fe8e205087de9a693460cdb918"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char ini_get_bool_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>def</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value into a logical value. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into a Boolean. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def</td><td>Default value to use if conversion failed. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns default value and sets error code into the provided variable. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0e3de518b496dc65276ec91956f1b267"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ini_get_string_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the copy of string stored in the configuration value. </p>
<p>Function creates a copy of the string value stored in the configuration element. Returned value needs to be freed after use. If error occurred the returned value will be NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to use. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Copy of the string or NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ga153ba9ffddfa4f47ab785d09fa8af4aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ini_get_const_string_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string stored in the configuration value. </p>
<p>Function returns a reference to the string value stored inside the configuration element. This string can't be altered. The string will go out of scope if the value object is deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to use. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String from the value object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga723e97bb34fb761f843315d769757500"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ini_get_bin_config_value </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value into a binary sequence. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into a sequence of bytes. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<p>The function allocates memory. It is the responsibility of the caller to free it after use. Use <a class="el" href="group__ini__value.html#gadc445f98e43dce6a34b19760a9b67d7c">ini_free_bin_config_value()</a> for this purpose. Functions will return NULL if conversion failed.</p>
<p>Function assumes that the value being interpreted has a special format. The string should be taken in single quotes and consist of hex encoded value represented by two hex digits per byte. Case does not matter.</p>
<p>Example: '0a2BFeCc'</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">length</td><td>Variable that optionally receives the length of the binary sequence. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed due invalid characters.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted value. In case of failure the function returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="gadc445f98e43dce6a34b19760a9b67d7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ini_free_bin_config_value </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>bin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free binary buffer. </p>
<p>Free binary value returned by <a class="el" href="group__ini__value.html#ga723e97bb34fb761f843315d769757500">ini_get_bin_config_value()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bin</td><td>Binary buffer to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8e08bd7d0db358450ff0cef6ba03790d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** ini_get_string_config_array </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to an array of strings. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration value object into an array of strings. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<p>Separator string includes up to three different separators. If separator NULL, comma is assumed. The spaces are trimmed automatically around separators in the string. The function drops empty tokens from the list. This means that the string like this: "apple, ,banana, ,orange ," will be translated into the list of three items: "apple","banana" and "orange".</p>
<p>The length of the allocated array is returned in "size". Size and error parameters can be NULL. Use <a class="el" href="group__ini__value.html#gaab4950b1dbc28fe9ad9f7f92e6f45f8b">ini_free_string_config_array()</a> to free the array after use.</p>
<p>The array is always NULL terminated so it is safe not to get size and just loop until array element is NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sep</td><td>String cosisting of separator symbols. For example: ",.;" would mean that comma, dot and semicolon should be treated as separators in the value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Variable that optionally receives the size of the array. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Array of strings. In case of failure the function returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ga72cc367e41127f2da94eb287751c9967"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** ini_get_raw_string_config_array </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to an array of strings. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an array of strings. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<p>Separator string includes up to three different separators. If separator NULL, comma is assumed. The spaces are trimmed automatically around separators in the string. The function does not drop empty tokens from the list. This means that the string like this: "apple, ,banana, ,orange ," will be translated into the list of five items: "apple", "", "banana", "" and "orange".</p>
<p>The length of the allocated array is returned in "size". Size and error parameters can be NULL. Use <a class="el" href="group__ini__value.html#gaab4950b1dbc28fe9ad9f7f92e6f45f8b">ini_free_string_config_array()</a> to free the array after use.</p>
<p>The array is always NULL terminated so it is safe not to get size and just loop until array element is NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sep</td><td>String cosisting of separator symbols. For example: ",.;" would mean that comma, dot and semicolon should be treated as separators in the value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Variable that optionally receives the size of the array. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Array of strings. In case of failure the function returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2503ecce2f57aef7e456e3dbbc5c92c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long* ini_get_long_config_array </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to an array of long values. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an array of long values. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<p>Separators inside the string are detected automatically. The spaces are trimmed automatically around separators in the string.</p>
<p>The length of the allocated array is returned in "size". Size parameter can't be NULL.</p>
<p>Use <a class="el" href="group__ini__value.html#gad083fe1029c5925d80e7f1496ae07d64">ini_free_long_config_array()</a> to free the array after use.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Variable that receives the size of the array. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed.</li>
<li>ERANGE - Value is out of range.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Array of long values. In case of failure the function returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1da3ee561958674017ea2a92048b26fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double* ini_get_double_config_array </td>
<td>(</td>
<td class="paramtype">struct value_obj * </td>
<td class="paramname"><em>vo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert value to an array of floating point values. </p>
<p>This is a conversion function. It converts the value read from the INI file and stored in the configuration element into an array of floating point values. Any of the conversion functions can be used to try to convert the value stored as a string inside the value object. The result can be different depending upon how the caller tries to interpret the value.</p>
<p>Separators inside the string are detected automatically. The spaces are trimmed automatically around separators in the string.</p>
<p>The length of the allocated array is returned in "size". Size parameter can't be NULL.</p>
<p>Use <a class="el" href="group__ini__value.html#gab27eadd9eb32994711063b43c81f528a">ini_free_double_config_array()</a> to free the array after use.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">vo</td><td>Value object to interpret. It must be retrieved using <a class="el" href="group__ini__value.html#gaab7f2ce07b399e15ead974fb4e3c7e77">ini_get_config_valueobj()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Variable that receives the size of the array. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>Variable will get the value of the error code if error happened. Can be NULL. In this case function does not set the code. Codes:<ul>
<li>0 - Success.</li>
<li>EINVAL - Argument is invalid.</li>
<li>EIO - Conversion failed.</li>
<li>ENOMEM - No memory.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Array of floating point values. In case of failure the function returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="gaab4950b1dbc28fe9ad9f7f92e6f45f8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ini_free_string_config_array </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>str_config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free array of string values. </p>
<p>Use this function to free the array returned by <a class="el" href="group__ini__value.html#ga8e08bd7d0db358450ff0cef6ba03790d">ini_get_string_config_array()</a> or by <a class="el" href="group__ini__value.html#ga72cc367e41127f2da94eb287751c9967">ini_get_raw_string_config_array()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str_config</td><td>Array of string values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad083fe1029c5925d80e7f1496ae07d64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ini_free_long_config_array </td>
<td>(</td>
<td class="paramtype">long * </td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free array of long values. </p>
<p>Use this function to free the array returned by <a class="el" href="group__ini__value.html#ga2503ecce2f57aef7e456e3dbbc5c92c0">ini_get_long_config_array()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>Array of long values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab27eadd9eb32994711063b43c81f528a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ini_free_double_config_array </td>
<td>(</td>
<td class="paramtype">double * </td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free array of floating pointer values. </p>
<p>Use this function to free the array returned by <a class="el" href="group__ini__value.html#ga1da3ee561958674017ea2a92048b26fc">ini_get_double_config_array()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>Array of floating pointer values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
f1fdcdb82c21d8820a1f9ab48439717f
>
files
>
34
