<!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"/>
<title>liblinphone: Miscenalleous: logs, version strings, config storage</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="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 style="padding-left: 0.5em;">
<div id="projectname">liblinphone
 <span id="projectnumber">3.5.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Miscenalleous: logs, version strings, config storage</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga047b6550aab7dd244268e695fab98fd6"><td class="memItemLeft" align="right" valign="top">typedef struct _LpConfig </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad70dc5268366c829238b458547fe5277"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gad70dc5268366c829238b458547fe5277">linphone_core_enable_logs</a> (FILE *file)</td></tr>
<tr class="memitem:gad7314fd936348037a14ba56cd2e9093e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gad7314fd936348037a14ba56cd2e9093e">linphone_core_enable_logs_with_cb</a> (OrtpLogFunc logfunc)</td></tr>
<tr class="memitem:gaac81b36333b8dcda6d029fd62720fae8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gaac81b36333b8dcda6d029fd62720fae8">linphone_core_disable_logs</a> ()</td></tr>
<tr class="memitem:ga553b61ad32d7455ce69102025d383f90"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga553b61ad32d7455ce69102025d383f90">linphone_core_get_version</a> (void)</td></tr>
<tr class="memitem:ga0ce5fcbca8718e4292bc29e9e58fef6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga0ce5fcbca8718e4292bc29e9e58fef6c">linphone_core_set_user_agent</a> (const char *name, const char *ver)</td></tr>
<tr class="memitem:ga0634038b0304863380c65d6743448cab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga0634038b0304863380c65d6743448cab">linphone_core_get_config</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:gade18763c25644d5ac7cf3a14dfc7552c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gade18763c25644d5ac7cf3a14dfc7552c">lp_config_get_string</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, const char *default_string)</td></tr>
<tr class="memitem:gabc3e1c0f3714bae304fd8e76da4588bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gabc3e1c0f3714bae304fd8e76da4588bc">lp_config_get_int</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, int default_value)</td></tr>
<tr class="memitem:gac261c029cb60b805df4a75ab372e74bc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gac261c029cb60b805df4a75ab372e74bc">lp_config_get_float</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, float default_value)</td></tr>
<tr class="memitem:ga2b9f058c7b12d124be96149100d9b079"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga2b9f058c7b12d124be96149100d9b079">lp_config_set_string</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, const char *value)</td></tr>
<tr class="memitem:gab7608c4c6b40a734eb00a4b398e47ba5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gab7608c4c6b40a734eb00a4b398e47ba5">lp_config_set_int</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, int value)</td></tr>
<tr class="memitem:gaeaa0ff38f2af3cefdf4c401b86ec9197"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gaeaa0ff38f2af3cefdf4c401b86ec9197">lp_config_set_float</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section, const char *key, float value)</td></tr>
<tr class="memitem:ga39f6f202e10581591ac6e68a636236bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga39f6f202e10581591ac6e68a636236bc">lp_config_sync</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig)</td></tr>
<tr class="memitem:ga80f79f159f8db667b2732750c7853947"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga80f79f159f8db667b2732750c7853947">lp_config_has_section</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section)</td></tr>
<tr class="memitem:ga8ea8060c147dd9584644c52d4cd59a17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga8ea8060c147dd9584644c52d4cd59a17">lp_config_clean_section</a> (<a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> *lpconfig, const char *section)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<h2>Typedef Documentation</h2>
<a class="anchor" id="ga047b6550aab7dd244268e695fab98fd6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _LpConfig <a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The LpConfig object is used to manipulate a configuration file.</p>
<p>The format of the configuration file is a .ini like format:</p>
<ul>
<li>sections are defined in []</li>
<li>each section contains a sequence of key=value pairs.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line">[sound]</div>
<div class="line">echocanceler=1</div>
<div class="line">playback_dev=ALSA: Default device</div>
<div class="line"></div>
<div class="line">[video]</div>
<div class="line">enabled=1</div>
</div><!-- fragment -->
</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="gad70dc5268366c829238b458547fe5277"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_enable_logs </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable logs in supplied FILE*.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>a C FILE* where to fprintf logs. If null stdout is used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad7314fd936348037a14ba56cd2e9093e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_enable_logs_with_cb </td>
<td>(</td>
<td class="paramtype">OrtpLogFunc </td>
<td class="paramname"><em>logfunc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable logs through the user's supplied log callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">logfunc</td><td>The address of a OrtpLogFunc callback whose protoype is typedef void (*OrtpLogFunc)(OrtpLogLevel lev, const char *fmt, va_list args); </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaac81b36333b8dcda6d029fd62720fae8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_disable_logs </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Entirely disable logging. </p>
</div>
</div>
<a class="anchor" id="ga553b61ad32d7455ce69102025d383f90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* linphone_core_get_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns liblinphone's version as a string. </p>
</div>
</div>
<a class="anchor" id="ga0ce5fcbca8718e4292bc29e9e58fef6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_set_user_agent </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">const char * </td>
<td class="paramname"><em>ver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the user agent string used in SIP messages. </p>
</div>
</div>
<a class="anchor" id="ga0634038b0304863380c65d6743448cab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a>* linphone_core_get_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the LpConfig object used to manage the storage (config) file.</p>
<p>The application can use the LpConfig object to insert its own private sections and pairs of key=value in the configuration file. </p>
</div>
</div>
<a class="anchor" id="gade18763c25644d5ac7cf3a14dfc7552c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lp_config_get_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>default_string</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a configuration item as a string, given its section, key, and default value.</p>
<p>The default value string is returned if the config item isn't found. </p>
</div>
</div>
<a class="anchor" id="gabc3e1c0f3714bae304fd8e76da4588bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lp_config_get_int </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>default_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a configuration item as an integer, given its section, key, and default value.</p>
<p>The default integer value is returned if the config item isn't found. </p>
</div>
</div>
<a class="anchor" id="gac261c029cb60b805df4a75ab372e74bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float lp_config_get_float </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>default_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a configuration item as a float, given its section, key, and default value.</p>
<p>The default float value is returned if the config item isn't found. </p>
</div>
</div>
<a class="anchor" id="ga2b9f058c7b12d124be96149100d9b079"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lp_config_set_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a string config item </p>
</div>
</div>
<a class="anchor" id="gab7608c4c6b40a734eb00a4b398e47ba5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lp_config_set_int </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an integer config item </p>
</div>
</div>
<a class="anchor" id="gaeaa0ff38f2af3cefdf4c401b86ec9197"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lp_config_set_float </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a float config item </p>
</div>
</div>
<a class="anchor" id="ga39f6f202e10581591ac6e68a636236bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lp_config_sync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the config file to disk. </p>
</div>
</div>
<a class="anchor" id="ga80f79f159f8db667b2732750c7853947"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lp_config_has_section </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns 1 if a given section is present in the configuration. </p>
</div>
</div>
<a class="anchor" id="ga8ea8060c147dd9584644c52d4cd59a17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lp_config_clean_section </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga047b6550aab7dd244268e695fab98fd6">LpConfig</a> * </td>
<td class="paramname"><em>lpconfig</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes every pair of key,value in a section and remove the section. </p>
</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.1.2
</small></address>
</body>
</html>
