<!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: Section and attribute 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">Section and attribute 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:ga33367f5b3a6f7d0d122485edeb976b75"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__section__and__attr.html#ga33367f5b3a6f7d0d122485edeb976b75">ini_get_section_list</a> (struct ini_cfgobj *ini_config, int *size, int *error)</td></tr> <tr class="memdesc:ga33367f5b3a6f7d0d122485edeb976b75"><td class="mdescLeft"> </td><td class="mdescRight">Get list of sections. <a href="#ga33367f5b3a6f7d0d122485edeb976b75">More...</a><br /></td></tr> <tr class="separator:ga33367f5b3a6f7d0d122485edeb976b75"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga881d2642fefea82b8f0412c39f4fe58a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__section__and__attr.html#ga881d2642fefea82b8f0412c39f4fe58a">ini_free_section_list</a> (char **section_list)</td></tr> <tr class="memdesc:ga881d2642fefea82b8f0412c39f4fe58a"><td class="mdescLeft"> </td><td class="mdescRight">Free list of sections. <a href="#ga881d2642fefea82b8f0412c39f4fe58a">More...</a><br /></td></tr> <tr class="separator:ga881d2642fefea82b8f0412c39f4fe58a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabe84620470cfdec944da26587c36fddd"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__section__and__attr.html#gabe84620470cfdec944da26587c36fddd">ini_get_attribute_list</a> (struct ini_cfgobj *ini_config, const char *section, int *size, int *error)</td></tr> <tr class="memdesc:gabe84620470cfdec944da26587c36fddd"><td class="mdescLeft"> </td><td class="mdescRight">Get list of attributes. <a href="#gabe84620470cfdec944da26587c36fddd">More...</a><br /></td></tr> <tr class="separator:gabe84620470cfdec944da26587c36fddd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga35e50e69c8af9852518e81d90653a76e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ini__section__and__attr.html#ga35e50e69c8af9852518e81d90653a76e">ini_free_attribute_list</a> (char **attr_list)</td></tr> <tr class="memdesc:ga35e50e69c8af9852518e81d90653a76e"><td class="mdescLeft"> </td><td class="mdescRight">Free list of attributes. <a href="#ga35e50e69c8af9852518e81d90653a76e">More...</a><br /></td></tr> <tr class="separator:ga35e50e69c8af9852518e81d90653a76e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Functions in this section allow getting the lists of sections in the configuration file and keys in a section as arrays of strings. </p> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga33367f5b3a6f7d0d122485edeb976b75"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char** ini_get_section_list </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>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>Get list of sections. </p> <p>Get list of sections from the configuration object as an array of strings. Function allocates memory for the array of the sections. Use <a class="el" href="group__ini__section__and__attr.html#ga881d2642fefea82b8f0412c39f4fe58a">ini_free_section_list()</a> to free allocated memory.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">ini_config</td><td>Configuration object. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>If not NULL parameter will receive number of sections in the configuration. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>If not NULL parameter will receive the error code. 0 - Success. EINVAL - Invalid parameter. ENOMEM - No memory.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Array of strings. </dd></dl> </div> </div> <a class="anchor" id="ga881d2642fefea82b8f0412c39f4fe58a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ini_free_section_list </td> <td>(</td> <td class="paramtype">char ** </td> <td class="paramname"><em>section_list</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free list of sections. </p> <p>The section array created by <a class="el" href="group__ini__section__and__attr.html#ga33367f5b3a6f7d0d122485edeb976b75">ini_get_section_list()</a> should be freed using this function.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">section_list</td><td>Array of strings returned by <a class="el" href="group__ini__section__and__attr.html#ga33367f5b3a6f7d0d122485edeb976b75">ini_get_section_list()</a> function. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="gabe84620470cfdec944da26587c36fddd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char** ini_get_attribute_list </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">const char * </td> <td class="paramname"><em>section</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>Get list of attributes. </p> <p>Get list of attributes in a section as an array of strings. Function allocates memory for the array of attributes. Use <a class="el" href="group__ini__section__and__attr.html#ga35e50e69c8af9852518e81d90653a76e">ini_free_attribute_list()</a> to free allocated memory.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">ini_config</td><td>Configuration object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">section</td><td>Section name. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>If not NULL parameter will receive number of attributes in the section. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">error</td><td>If not NULL parameter will receive the error code. 0 - Success. EINVAL - Invalid parameter. ENOMEM - No memory.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Array of strings. </dd></dl> </div> </div> <a class="anchor" id="ga35e50e69c8af9852518e81d90653a76e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ini_free_attribute_list </td> <td>(</td> <td class="paramtype">char ** </td> <td class="paramname"><em>attr_list</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free list of attributes. </p> <p>The attribute array created by <a class="el" href="group__ini__section__and__attr.html#gabe84620470cfdec944da26587c36fddd">ini_get_attribute_list()</a> should be freed using this function.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">attr_list</td><td>Array of strings returned by <a class="el" href="group__ini__section__and__attr.html#gabe84620470cfdec944da26587c36fddd">ini_get_attribute_list()</a> function. </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>