<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en" xml:lang="en">
<head>
<title>lomoco: iniparser/src/iniparser.h Source File</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="stylesheet" type="text/css" href="doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" href="csync.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="print.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div style="padding: 10px 30px;">
<!-- <img alt ="" src="top-kde.jpg"/> -->
csync API Reference </div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="index.html">csync</a></li>
</ul>
</div>
<div id="menu">
<ul><li><a href="http://www.csync.org/">Sitemap</a></li>
<li><a href="http://www.csync.org/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<!-- <h2><a name="content"></a>lomoco</h2> -->
<!-- BC -->
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="dir_83899319ec122a03d431d68c45b0dd06.html">iniparser</a> » <a class="el" href="dir_78cebf553df91c53d1da58b5e3c2bd5d.html">src</a>
</div>
<div class="contents">
<h1>iniparser.h</h1><a href="iniparser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">/**</span>
<a name="l00004"></a>00004 <span class="comment"> @file iniparser.h</span>
<a name="l00005"></a>00005 <span class="comment"> @author N. Devillard</span>
<a name="l00006"></a>00006 <span class="comment"> @date Mar 2000</span>
<a name="l00007"></a>00007 <span class="comment"> @version $Revision: 1.23 $</span>
<a name="l00008"></a>00008 <span class="comment"> @brief Parser for ini files.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment">/*</span>
<a name="l00013"></a>00013 <span class="comment"> $Id: iniparser.h,v 1.23 2006-09-27 11:03:35 ndevilla Exp $</span>
<a name="l00014"></a>00014 <span class="comment"> $Author: ndevilla $</span>
<a name="l00015"></a>00015 <span class="comment"> $Date: 2006-09-27 11:03:35 $</span>
<a name="l00016"></a>00016 <span class="comment"> $Revision: 1.23 $</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef _INIPARSER_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define _INIPARSER_H_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="comment">/*---------------------------------------------------------------------------</span>
<a name="l00023"></a>00023 <span class="comment"> Includes</span>
<a name="l00024"></a>00024 <span class="comment"> ---------------------------------------------------------------------------*/</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdio.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string.h></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="comment">/*</span>
<a name="l00031"></a>00031 <span class="comment"> * The following #include is necessary on many Unixes but not Linux.</span>
<a name="l00032"></a>00032 <span class="comment"> * It is not needed for Windows platforms.</span>
<a name="l00033"></a>00033 <span class="comment"> * Uncomment it if needed.</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="comment">/* #include <unistd.h> */</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="dictionary_8h.html" title="Implements a dictionary for string variables.">dictionary.h</a>"</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment">/**</span>
<a name="l00041"></a>00041 <span class="comment"> @brief Get number of sections in a dictionary</span>
<a name="l00042"></a>00042 <span class="comment"> @param d Dictionary to examine</span>
<a name="l00043"></a>00043 <span class="comment"> @return int Number of sections found in dictionary</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment"> This function returns the number of sections found in a dictionary.</span>
<a name="l00046"></a>00046 <span class="comment"> The test to recognize sections is done on the string stored in the</span>
<a name="l00047"></a>00047 <span class="comment"> dictionary: a section name is given as "section" whereas a key is</span>
<a name="l00048"></a>00048 <span class="comment"> stored as "section:key", thus the test looks for entries that do not</span>
<a name="l00049"></a>00049 <span class="comment"> contain a colon.</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> This clearly fails in the case a section name contains a colon, but</span>
<a name="l00052"></a>00052 <span class="comment"> this should simply be avoided.</span>
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> This function returns -1 in case of error.</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keywordtype">int</span> <a class="code" href="iniparser_8h.html#0b5d6cdc7587e2d27a30f5cdc4a91931" title="Get number of sections in a dictionary.">iniparser_getnsec</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d);
<a name="l00059"></a>00059
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/**</span>
<a name="l00063"></a>00063 <span class="comment"> @brief Get name for section n in a dictionary.</span>
<a name="l00064"></a>00064 <span class="comment"> @param d Dictionary to examine</span>
<a name="l00065"></a>00065 <span class="comment"> @param n Section number (from 0 to nsec-1).</span>
<a name="l00066"></a>00066 <span class="comment"> @return Pointer to char string</span>
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> This function locates the n-th section in a dictionary and returns</span>
<a name="l00069"></a>00069 <span class="comment"> its name as a pointer to a string statically allocated inside the</span>
<a name="l00070"></a>00070 <span class="comment"> dictionary. Do not free or modify the returned string!</span>
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> This function returns NULL in case of error.</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordtype">char</span> * <a class="code" href="iniparser_8h.html#393212be805f395bbfdeb1bafa8bb72a" title="Get name for section n in a dictionary.">iniparser_getsecname</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keywordtype">int</span> n);
<a name="l00077"></a>00077
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/**</span>
<a name="l00081"></a>00081 <span class="comment"> @brief Save a dictionary to a loadable ini file</span>
<a name="l00082"></a>00082 <span class="comment"> @param d Dictionary to dump</span>
<a name="l00083"></a>00083 <span class="comment"> @param f Opened file pointer to dump to</span>
<a name="l00084"></a>00084 <span class="comment"> @return void</span>
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> This function dumps a given dictionary into a loadable ini file.</span>
<a name="l00087"></a>00087 <span class="comment"> It is Ok to specify @c stderr or @c stdout as output files.</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="iniparser_8h.html#ece0e32de371c9e9592d8333f816dfac" title="Save a dictionary to a loadable ini file.">iniparser_dump_ini</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, FILE * f);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/**</span>
<a name="l00095"></a>00095 <span class="comment"> @brief Dump a dictionary to an opened file pointer.</span>
<a name="l00096"></a>00096 <span class="comment"> @param d Dictionary to dump.</span>
<a name="l00097"></a>00097 <span class="comment"> @param f Opened file pointer to dump to.</span>
<a name="l00098"></a>00098 <span class="comment"> @return void</span>
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> This function prints out the contents of a dictionary, one element by</span>
<a name="l00101"></a>00101 <span class="comment"> line, onto the provided file pointer. It is OK to specify @c stderr</span>
<a name="l00102"></a>00102 <span class="comment"> or @c stdout as output files. This function is meant for debugging</span>
<a name="l00103"></a>00103 <span class="comment"> purposes mostly.</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00106"></a>00106 <span class="keywordtype">void</span> <a class="code" href="iniparser_8h.html#046436b3489cd8854ba8e29109250324" title="Dump a dictionary to an opened file pointer.">iniparser_dump</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, FILE * f);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment">/**</span>
<a name="l00110"></a>00110 <span class="comment"> @brief Get the string associated to a key, return NULL if not found</span>
<a name="l00111"></a>00111 <span class="comment"> @param d Dictionary to search</span>
<a name="l00112"></a>00112 <span class="comment"> @param key Key string to look for</span>
<a name="l00113"></a>00113 <span class="comment"> @return pointer to statically allocated character string, or NULL.</span>
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> This function queries a dictionary for a key. A key as read from an</span>
<a name="l00116"></a>00116 <span class="comment"> ini file is given as "section:key". If the key cannot be found,</span>
<a name="l00117"></a>00117 <span class="comment"> NULL is returned.</span>
<a name="l00118"></a>00118 <span class="comment"> The returned char pointer is pointing to a string allocated in</span>
<a name="l00119"></a>00119 <span class="comment"> the dictionary, do not free or modify it.</span>
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment"> This function is only provided for backwards compatibility with</span>
<a name="l00122"></a>00122 <span class="comment"> previous versions of iniparser. It is recommended to use</span>
<a name="l00123"></a>00123 <span class="comment"> iniparser_getstring() instead.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00126"></a>00126 <span class="keywordtype">char</span> * <a class="code" href="iniparser_8h.html#587eafb48937fdee8ae414ad7a666db8" title="Get the string associated to a key, return NULL if not found.">iniparser_getstr</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keyword">const</span> <span class="keywordtype">char</span> * key);
<a name="l00127"></a>00127
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment">/**</span>
<a name="l00131"></a>00131 <span class="comment"> @brief Get the string associated to a key</span>
<a name="l00132"></a>00132 <span class="comment"> @param d Dictionary to search</span>
<a name="l00133"></a>00133 <span class="comment"> @param key Key string to look for</span>
<a name="l00134"></a>00134 <span class="comment"> @param def Default value to return if key not found.</span>
<a name="l00135"></a>00135 <span class="comment"> @return pointer to statically allocated character string</span>
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment"> This function queries a dictionary for a key. A key as read from an</span>
<a name="l00138"></a>00138 <span class="comment"> ini file is given as "section:key". If the key cannot be found,</span>
<a name="l00139"></a>00139 <span class="comment"> the pointer passed as 'def' is returned.</span>
<a name="l00140"></a>00140 <span class="comment"> The returned char pointer is pointing to a string allocated in</span>
<a name="l00141"></a>00141 <span class="comment"> the dictionary, do not free or modify it.</span>
<a name="l00142"></a>00142 <span class="comment"> */</span>
<a name="l00143"></a>00143 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00144"></a>00144 <span class="keywordtype">char</span> * <a class="code" href="iniparser_8h.html#7894f8480e1f254d4a1b4a31bdc51b46" title="Get the string associated to a key.">iniparser_getstring</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keyword">const</span> <span class="keywordtype">char</span> * key, <span class="keywordtype">char</span> * def);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment">/**</span>
<a name="l00148"></a>00148 <span class="comment"> @brief Get the string associated to a key, convert to an int</span>
<a name="l00149"></a>00149 <span class="comment"> @param d Dictionary to search</span>
<a name="l00150"></a>00150 <span class="comment"> @param key Key string to look for</span>
<a name="l00151"></a>00151 <span class="comment"> @param notfound Value to return in case of error</span>
<a name="l00152"></a>00152 <span class="comment"> @return integer</span>
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 <span class="comment"> This function queries a dictionary for a key. A key as read from an</span>
<a name="l00155"></a>00155 <span class="comment"> ini file is given as "section:key". If the key cannot be found,</span>
<a name="l00156"></a>00156 <span class="comment"> the notfound value is returned.</span>
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment"> Supported values for integers include the usual C notation</span>
<a name="l00159"></a>00159 <span class="comment"> so decimal, octal (starting with 0) and hexadecimal (starting with 0x)</span>
<a name="l00160"></a>00160 <span class="comment"> are supported. Examples:</span>
<a name="l00161"></a>00161 <span class="comment"></span>
<a name="l00162"></a>00162 <span class="comment"> - "42" -> 42</span>
<a name="l00163"></a>00163 <span class="comment"> - "042" -> 34 (octal -> decimal)</span>
<a name="l00164"></a>00164 <span class="comment"> - "0x42" -> 66 (hexa -> decimal)</span>
<a name="l00165"></a>00165 <span class="comment"></span>
<a name="l00166"></a>00166 <span class="comment"> Warning: the conversion may overflow in various ways. Conversion is</span>
<a name="l00167"></a>00167 <span class="comment"> totally outsourced to strtol(), see the associated man page for overflow</span>
<a name="l00168"></a>00168 <span class="comment"> handling.</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> Credits: Thanks to A. Becker for suggesting strtol()</span>
<a name="l00171"></a>00171 <span class="comment"> */</span>
<a name="l00172"></a>00172 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00173"></a>00173 <span class="keywordtype">int</span> <a class="code" href="iniparser_8h.html#694eb1110f4200db8648820a0bb405fa" title="Get the string associated to a key, convert to an int.">iniparser_getint</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keyword">const</span> <span class="keywordtype">char</span> * key, <span class="keywordtype">int</span> notfound);
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00176"></a>00176 <span class="comment">/**</span>
<a name="l00177"></a>00177 <span class="comment"> @brief Get the string associated to a key, convert to a double</span>
<a name="l00178"></a>00178 <span class="comment"> @param d Dictionary to search</span>
<a name="l00179"></a>00179 <span class="comment"> @param key Key string to look for</span>
<a name="l00180"></a>00180 <span class="comment"> @param notfound Value to return in case of error</span>
<a name="l00181"></a>00181 <span class="comment"> @return double</span>
<a name="l00182"></a>00182 <span class="comment"></span>
<a name="l00183"></a>00183 <span class="comment"> This function queries a dictionary for a key. A key as read from an</span>
<a name="l00184"></a>00184 <span class="comment"> ini file is given as "section:key". If the key cannot be found,</span>
<a name="l00185"></a>00185 <span class="comment"> the notfound value is returned.</span>
<a name="l00186"></a>00186 <span class="comment"> */</span>
<a name="l00187"></a>00187 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00188"></a>00188 <span class="keywordtype">double</span> <a class="code" href="iniparser_8h.html#480d35322f1252344cf2246ac21ee559" title="Get the string associated to a key, convert to a double.">iniparser_getdouble</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keywordtype">char</span> * key, <span class="keywordtype">double</span> notfound);
<a name="l00189"></a>00189
<a name="l00190"></a>00190 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00191"></a>00191 <span class="comment">/**</span>
<a name="l00192"></a>00192 <span class="comment"> @brief Get the string associated to a key, convert to a boolean</span>
<a name="l00193"></a>00193 <span class="comment"> @param d Dictionary to search</span>
<a name="l00194"></a>00194 <span class="comment"> @param key Key string to look for</span>
<a name="l00195"></a>00195 <span class="comment"> @param notfound Value to return in case of error</span>
<a name="l00196"></a>00196 <span class="comment"> @return integer</span>
<a name="l00197"></a>00197 <span class="comment"></span>
<a name="l00198"></a>00198 <span class="comment"> This function queries a dictionary for a key. A key as read from an</span>
<a name="l00199"></a>00199 <span class="comment"> ini file is given as "section:key". If the key cannot be found,</span>
<a name="l00200"></a>00200 <span class="comment"> the notfound value is returned.</span>
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment"> A true boolean is found if one of the following is matched:</span>
<a name="l00203"></a>00203 <span class="comment"></span>
<a name="l00204"></a>00204 <span class="comment"> - A string starting with 'y'</span>
<a name="l00205"></a>00205 <span class="comment"> - A string starting with 'Y'</span>
<a name="l00206"></a>00206 <span class="comment"> - A string starting with 't'</span>
<a name="l00207"></a>00207 <span class="comment"> - A string starting with 'T'</span>
<a name="l00208"></a>00208 <span class="comment"> - A string starting with '1'</span>
<a name="l00209"></a>00209 <span class="comment"></span>
<a name="l00210"></a>00210 <span class="comment"> A false boolean is found if one of the following is matched:</span>
<a name="l00211"></a>00211 <span class="comment"></span>
<a name="l00212"></a>00212 <span class="comment"> - A string starting with 'n'</span>
<a name="l00213"></a>00213 <span class="comment"> - A string starting with 'N'</span>
<a name="l00214"></a>00214 <span class="comment"> - A string starting with 'f'</span>
<a name="l00215"></a>00215 <span class="comment"> - A string starting with 'F'</span>
<a name="l00216"></a>00216 <span class="comment"> - A string starting with '0'</span>
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment"> The notfound value returned if no boolean is identified, does not</span>
<a name="l00219"></a>00219 <span class="comment"> necessarily have to be 0 or 1.</span>
<a name="l00220"></a>00220 <span class="comment"> */</span>
<a name="l00221"></a>00221 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00222"></a>00222 <span class="keywordtype">int</span> <a class="code" href="iniparser_8h.html#eb93c13fcbb75efaa396f53bfd73ff4d" title="Get the string associated to a key, convert to a boolean.">iniparser_getboolean</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d, <span class="keyword">const</span> <span class="keywordtype">char</span> * key, <span class="keywordtype">int</span> notfound);
<a name="l00223"></a>00223
<a name="l00224"></a>00224
<a name="l00225"></a>00225 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00226"></a>00226 <span class="comment">/**</span>
<a name="l00227"></a>00227 <span class="comment"> @brief Set an entry in a dictionary.</span>
<a name="l00228"></a>00228 <span class="comment"> @param ini Dictionary to modify.</span>
<a name="l00229"></a>00229 <span class="comment"> @param entry Entry to modify (entry name)</span>
<a name="l00230"></a>00230 <span class="comment"> @param val New value to associate to the entry.</span>
<a name="l00231"></a>00231 <span class="comment"> @return int 0 if Ok, -1 otherwise.</span>
<a name="l00232"></a>00232 <span class="comment"></span>
<a name="l00233"></a>00233 <span class="comment"> If the given entry can be found in the dictionary, it is modified to</span>
<a name="l00234"></a>00234 <span class="comment"> contain the provided value. If it cannot be found, -1 is returned.</span>
<a name="l00235"></a>00235 <span class="comment"> It is Ok to set val to NULL.</span>
<a name="l00236"></a>00236 <span class="comment"> */</span>
<a name="l00237"></a>00237 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00238"></a>00238
<a name="l00239"></a>00239 <span class="keywordtype">int</span> <a class="code" href="iniparser_8h.html#605a88057bac4c3249513fc588421c32" title="Set an entry in a dictionary.">iniparser_setstr</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * ini, <span class="keywordtype">char</span> * entry, <span class="keywordtype">char</span> * val);
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00242"></a>00242 <span class="comment">/**</span>
<a name="l00243"></a>00243 <span class="comment"> @brief Delete an entry in a dictionary</span>
<a name="l00244"></a>00244 <span class="comment"> @param ini Dictionary to modify</span>
<a name="l00245"></a>00245 <span class="comment"> @param entry Entry to delete (entry name)</span>
<a name="l00246"></a>00246 <span class="comment"> @return void</span>
<a name="l00247"></a>00247 <span class="comment"></span>
<a name="l00248"></a>00248 <span class="comment"> If the given entry can be found, it is deleted from the dictionary.</span>
<a name="l00249"></a>00249 <span class="comment"> */</span>
<a name="l00250"></a>00250 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00251"></a>00251 <span class="keywordtype">void</span> <a class="code" href="iniparser_8h.html#7b1a7f2492a35043867fa801b8f21e52" title="Delete an entry in a dictionary.">iniparser_unset</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * ini, <span class="keywordtype">char</span> * entry);
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00254"></a>00254 <span class="comment">/**</span>
<a name="l00255"></a>00255 <span class="comment"> @brief Finds out if a given entry exists in a dictionary</span>
<a name="l00256"></a>00256 <span class="comment"> @param ini Dictionary to search</span>
<a name="l00257"></a>00257 <span class="comment"> @param entry Name of the entry to look for</span>
<a name="l00258"></a>00258 <span class="comment"> @return integer 1 if entry exists, 0 otherwise</span>
<a name="l00259"></a>00259 <span class="comment"></span>
<a name="l00260"></a>00260 <span class="comment"> Finds out if a given entry exists in the dictionary. Since sections</span>
<a name="l00261"></a>00261 <span class="comment"> are stored as keys with NULL associated values, this is the only way</span>
<a name="l00262"></a>00262 <span class="comment"> of querying for the presence of sections in a dictionary.</span>
<a name="l00263"></a>00263 <span class="comment"> */</span>
<a name="l00264"></a>00264 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00265"></a>00265 <span class="keywordtype">int</span> <a class="code" href="iniparser_8h.html#3d67c98bbc0cb5239f024ad54bdc63f1" title="Finds out if a given entry exists in a dictionary.">iniparser_find_entry</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * ini, <span class="keywordtype">char</span> * entry) ;
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00268"></a>00268 <span class="comment">/**</span>
<a name="l00269"></a>00269 <span class="comment"> @brief Parse an ini file and return an allocated dictionary object</span>
<a name="l00270"></a>00270 <span class="comment"> @param ininame Name of the ini file to read.</span>
<a name="l00271"></a>00271 <span class="comment"> @return Pointer to newly allocated dictionary</span>
<a name="l00272"></a>00272 <span class="comment"></span>
<a name="l00273"></a>00273 <span class="comment"> This is the parser for ini files. This function is called, providing</span>
<a name="l00274"></a>00274 <span class="comment"> the name of the file to be read. It returns a dictionary object that</span>
<a name="l00275"></a>00275 <span class="comment"> should not be accessed directly, but through accessor functions</span>
<a name="l00276"></a>00276 <span class="comment"> instead.</span>
<a name="l00277"></a>00277 <span class="comment"></span>
<a name="l00278"></a>00278 <span class="comment"> The returned dictionary must be freed using iniparser_freedict().</span>
<a name="l00279"></a>00279 <span class="comment"> */</span>
<a name="l00280"></a>00280 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00281"></a>00281 <a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * <a class="code" href="iniparser_8h.html#b0be559bfb769224b3f1b75e26242a67" title="Parse an ini file and return an allocated dictionary object.">iniparser_load</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * ininame);
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="comment">/*-------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00284"></a>00284 <span class="comment">/**</span>
<a name="l00285"></a>00285 <span class="comment"> @brief Free all memory associated to an ini dictionary</span>
<a name="l00286"></a>00286 <span class="comment"> @param d Dictionary to free</span>
<a name="l00287"></a>00287 <span class="comment"> @return void</span>
<a name="l00288"></a>00288 <span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment"> Free all memory associated to an ini dictionary.</span>
<a name="l00290"></a>00290 <span class="comment"> It is mandatory to call this function before the dictionary object</span>
<a name="l00291"></a>00291 <span class="comment"> gets out of the current context.</span>
<a name="l00292"></a>00292 <span class="comment"> */</span>
<a name="l00293"></a>00293 <span class="comment">/*--------------------------------------------------------------------------*/</span>
<a name="l00294"></a>00294 <span class="keywordtype">void</span> <a class="code" href="iniparser_8h.html#90549ee518523921886b74454ff872eb" title="Free all memory associated to an ini dictionary.">iniparser_freedict</a>(<a class="code" href="struct__dictionary__.html" title="Dictionary object.">dictionary</a> * d);
<a name="l00295"></a>00295
<a name="l00296"></a>00296 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">lomoco</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "lomoco"</a>
</div></div>
<!-- menu -->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">API Documentation</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "@topname@"</a>
</div></div>
<div class="nav_list">
<ul>
<!-- gmenu -->
</ul></div></div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Generated with <a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">Doxygen</a>
</div></div>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
48aebc76604d00e261fd2a64f42d7eb8
>
files
>
57
