From cb9232b3ab413fae7bcc2b94abd70f18ca02b263 Mon Sep 17 00:00:00 2001
From: wxr <wxr@hdlchina.com.cn>
Date: 星期二, 03 十二月 2024 11:20:32 +0800
Subject: [PATCH] 增加铃声；增加TCP/UDP连接选择

---
 Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/lpconfig.h |  411 +++++++++++++++++++++++++++++++++++++---------------------
 1 files changed, 259 insertions(+), 152 deletions(-)

diff --git a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/lpconfig.h b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/lpconfig.h
index f347f9b..a0dee19 100755
--- a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/lpconfig.h
+++ b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/lpconfig.h
@@ -56,8 +56,9 @@
  * Instantiates a #LinphoneConfig object from a user config file.
  * The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
  * @ingroup misc
- * @param filename the filename of the config file to read to fill the instantiated #LinphoneConfig
- * @see linphone_config_new_with_factory
+ * @param filename the filename of the config file to read to fill the instantiated #LinphoneConfig @maybenil
+ * @see linphone_config_new_with_factory()
+ * @return a #LinphoneConfig object @maybenil
  */
 LINPHONE_PUBLIC LinphoneConfig * linphone_config_new(const char *filename);
 
@@ -65,9 +66,10 @@
  * Instantiates a #LinphoneConfig object from a user provided buffer.
  * The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
  * @ingroup misc
- * @param buffer the buffer from which the #LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.
- * @see linphone_config_new_with_factory
- * @see linphone_config_new
+ * @param buffer the buffer from which the #LinphoneConfig will be retrieved. We expect the buffer to be null-terminated. @notnil
+ * @see linphone_config_new_with_factory()
+ * @see linphone_config_new()
+ * @return a #LinphoneConfig object @notnil
  */
 LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_from_buffer(const char *buffer);
 
@@ -75,9 +77,10 @@
  * Instantiates a #LinphoneConfig object from a user config file and a factory config file.
  * The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
  * @ingroup misc
- * @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig
- * @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig
- * @see linphone_config_new
+ * @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig @maybenil
+ * @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig @maybenil
+ * @see linphone_config_new()
+ * @return a #LinphoneConfig object @maybenil
  *
  * The user config file is read first to fill the #LinphoneConfig and then the factory config file is read.
  * Therefore the configuration parameters defined in the user config file will be overwritten by the parameters
@@ -93,391 +96,495 @@
  * "group id" in the project settings.
  * The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
  * @ingroup misc
- * @param app_group_id used to compute the path of the config file in the file system shared by the shared Cores
- * @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig
- * @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig
- * @see linphone_config_new
+ * @param app_group_id used to compute the path of the config file in the file system shared by the shared Cores @notnil
+ * @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig @maybenil
+ * @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig @maybenil
+ * @see linphone_config_new()
+ * @return a #LinphoneConfig object @maybenil
  *
  * The user config file is read first to fill the #LinphoneConfig and then the factory config file is read.
  * Therefore the configuration parameters defined in the user config file will be overwritten by the parameters
  * defined in the factory config file.
  */
-LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_for_shared_core(const char *app_group_id, const char* config_filename, const char *factory_path);
+LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_for_shared_core(const char *app_group_id, const char* config_filename, const char *factory_config_filename);
 
 /**
  * Reads a user config file and fill the #LinphoneConfig with the read config values.
  * @ingroup misc
- * @param lpconfig The #LinphoneConfig object to fill with the content of the file
- * @param filename The filename of the config file to read to fill the #LinphoneConfig
+ * @param config The #LinphoneConfig object to fill with the content of the file @notnil
+ * @param filename The filename of the config file to read to fill the #LinphoneConfig @notnil
  */
-LINPHONE_PUBLIC LinphoneStatus linphone_config_read_file(LinphoneConfig *lpconfig, const char *filename);
+LINPHONE_PUBLIC LinphoneStatus linphone_config_read_file(LinphoneConfig *config, const char *filename);
 
 /**
  * Reads a xml config file and fill the #LinphoneConfig with the read config dynamic values.
  * @ingroup misc
- * @param lpconfig The #LinphoneConfig object to fill with the content of the file
- * @param filename The filename of the config file to read to fill the #LinphoneConfig
+ * @param config The #LinphoneConfig object to fill with the content of the file @notnil
+ * @param filename The filename of the config file to read to fill the #LinphoneConfig @notnil
  */
-LINPHONE_PUBLIC const char* linphone_config_load_from_xml_file(LinphoneConfig *lpc, const char *filename);
+LINPHONE_PUBLIC const char* linphone_config_load_from_xml_file(LinphoneConfig *config, const char *filename);
 
 /**
  * Reads a xml config string and fill the #LinphoneConfig with the read config dynamic values.
  * @ingroup misc
- * @param lpconfig The #LinphoneConfig object to fill with the content of the file
- * @param buffer The string of the config file to fill the #LinphoneConfig
+ * @param config The #LinphoneConfig object to fill with the content of the file @notnil
+ * @param buffer The string of the config file to fill the #LinphoneConfig @notnil
  * @return 0 in case of success
  */
-LINPHONE_PUBLIC LinphoneStatus linphone_config_load_from_xml_string(LpConfig *lpc, const char *buffer);
+LINPHONE_PUBLIC LinphoneStatus linphone_config_load_from_xml_string(LinphoneConfig *config, const char *buffer);
 
 /**
  * Retrieves a configuration item as a string, given its section, key, and default value.
  *
  * The default value string is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_string The default value to return if not found. @maybenil
+ * @return the found value or the default one if not found. @maybenil
 **/
-LINPHONE_PUBLIC const char *linphone_config_get_string(const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_string);
+LINPHONE_PUBLIC const char *linphone_config_get_string(const LinphoneConfig *config, const char *section, const char *key, const char *default_string);
 
 /**
  * Retrieves a configuration item as a list of strings, given its section, key, and default value.
  * The default value is returned if the config item is not found.
- * @param[in] lpconfig A #LinphoneConfig object
- * @param[in] section The section from which to retrieve a configuration item
- * @param[in] key The name of the configuration item to retrieve
- * @param[in] default_list \bctbx_list{const char *}
- * @return \bctbx_list{const char *}
+ * @param config A #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_list The list to return when the key doesn't exist. \bctbx_list{const char *} @maybenil
+ * @return A list of strings. \bctbx_list{const char *} @maybenil
  */
-LINPHONE_PUBLIC bctbx_list_t * linphone_config_get_string_list(const LinphoneConfig *lpconfig, const char *section, const char *key, bctbx_list_t *default_list);
+LINPHONE_PUBLIC bctbx_list_t * linphone_config_get_string_list(const LinphoneConfig *config, const char *section, const char *key, bctbx_list_t *default_list);
 
 /**
  * Retrieves a configuration item as a range, given its section, key, and default min and max values.
  *
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param[out] min The min value found or default_min @notnil
+ * @param[out] max The max value found or default_max @notnil
+ * @param default_min the default min value to return if not found
+ * @param default_max the default max value to return if not found.
  * @return TRUE if the value is successfully parsed as a range, FALSE otherwise.
  * If FALSE is returned, min and max are filled respectively with default_min and default_max values.
  */
-LINPHONE_PUBLIC bool_t linphone_config_get_range(const LinphoneConfig *lpconfig, const char *section, const char *key, int *min, int *max, int default_min, int default_max);
+LINPHONE_PUBLIC bool_t linphone_config_get_range(const LinphoneConfig *config, const char *section, const char *key, int *min, int *max, int default_min, int default_max);
 
 /**
  * Retrieves a configuration item as an integer, given its section, key, and default value.
  *
  * The default integer value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found value or default_value if not found.
 **/
-LINPHONE_PUBLIC int linphone_config_get_int(const LinphoneConfig *lpconfig,const char *section, const char *key, int default_value);
+LINPHONE_PUBLIC int linphone_config_get_int(const LinphoneConfig *config, const char *section, const char *key, int default_value);
 
 /**
  * Retrieves a configuration item as a boolean, given its section, key, and default value.
  *
  * The default boolean value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found value or default_value if not found.
 **/
-LINPHONE_PUBLIC bool_t linphone_config_get_bool(const LpConfig *lpconfig, const char *section, const char *key, bool_t default_value);
+LINPHONE_PUBLIC bool_t linphone_config_get_bool(const LinphoneConfig *config, const char *section, const char *key, bool_t default_value);
 
 /**
  * Retrieves a configuration item as a 64 bit integer, given its section, key, and default value.
  *
  * The default integer value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found value or default_value if not found.
 **/
-LINPHONE_PUBLIC int64_t linphone_config_get_int64(const LinphoneConfig *lpconfig,const char *section, const char *key, int64_t default_value);
+LINPHONE_PUBLIC int64_t linphone_config_get_int64(const LinphoneConfig *config, const char *section, const char *key, int64_t default_value);
 
 /**
  * Retrieves a configuration item as a float, given its section, key, and default value.
  *
  * The default float value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found value or default_value if not found.
 **/
-LINPHONE_PUBLIC float linphone_config_get_float(const LinphoneConfig *lpconfig,const char *section, const char *key, float default_value);
+LINPHONE_PUBLIC float linphone_config_get_float(const LinphoneConfig *config, const char *section, const char *key, float default_value);
 
 /**
  * Sets a string config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value The value to set @maybenil
 **/
-LINPHONE_PUBLIC void linphone_config_set_string(LinphoneConfig *lpconfig,const char *section, const char *key, const char *value);
+LINPHONE_PUBLIC void linphone_config_set_string(LinphoneConfig *config,const char *section, const char *key, const char *value);
 
 /**
  * Sets a string list config item
- * @param[in] lpconfig A #LinphoneConfig object
- * @param[in] section The name of the section to put the configuration item into
- * @param[in] key The name of the configuration item to set
- * @param[in] value \bctbx_list{const char *} The value to set
+ * @param config A #LinphoneConfig object @notnil
+ * @param section The name of the section to put the configuration item into @notnil
+ * @param key The name of the configuration item to set @notnil
+ * @param value The value to set. \bctbx_list{const char *} @maybenil
  */
-LINPHONE_PUBLIC void linphone_config_set_string_list(LinphoneConfig *lpconfig, const char *section, const char *key, const bctbx_list_t *value);
+LINPHONE_PUBLIC void linphone_config_set_string_list(LinphoneConfig *config, const char *section, const char *key, const bctbx_list_t *value);
 
 /**
  * Sets a range config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param min_value the min value to set
+ * @param max_value the max value to set
  */
-LINPHONE_PUBLIC void linphone_config_set_range(LinphoneConfig *lpconfig, const char *section, const char *key, int min_value, int max_value);
+LINPHONE_PUBLIC void linphone_config_set_range(LinphoneConfig *config, const char *section, const char *key, int min_value, int max_value);
 
 /**
  * Sets an integer config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value the value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_int(LinphoneConfig *lpconfig,const char *section, const char *key, int value);
+LINPHONE_PUBLIC void linphone_config_set_int(LinphoneConfig *config,const char *section, const char *key, int value);
 
 /**
  * Sets a boolean config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value the value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_bool(LinphoneConfig *lpconfig,const char *section, const char *key, bool_t value);
+LINPHONE_PUBLIC void linphone_config_set_bool(LinphoneConfig *config,const char *section, const char *key, bool_t value);
 
 /**
  * Sets an integer config item, but store it as hexadecimal
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value the value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_int_hex(LinphoneConfig *lpconfig,const char *section, const char *key, int value);
+LINPHONE_PUBLIC void linphone_config_set_int_hex(LinphoneConfig *config,const char *section, const char *key, int value);
 
 /**
  * Sets a 64 bits integer config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value the value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_int64(LinphoneConfig *lpconfig,const char *section, const char *key, int64_t value);
+LINPHONE_PUBLIC void linphone_config_set_int64(LinphoneConfig *config,const char *section, const char *key, int64_t value);
 
 /**
  * Sets a float config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve a configuration item @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param value the value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_float(LinphoneConfig *lpconfig,const char *section, const char *key, float value);
+LINPHONE_PUBLIC void linphone_config_set_float(LinphoneConfig *config,const char *section, const char *key, float value);
 
 /**
  * Writes the config file to disk.
+ * @param config The #LinphoneConfig object @notnil
+ * @return 0 if successful, -1 otherwise
 **/
-LINPHONE_PUBLIC LinphoneStatus linphone_config_sync(LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC LinphoneStatus linphone_config_sync(LinphoneConfig *config);
 
 /**
  * Reload the config from the file.
+ * @param config The #LinphoneConfig object @notnil
 **/
-LINPHONE_PUBLIC void linphone_config_reload(LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC void linphone_config_reload(LinphoneConfig *config);
 
 /**
- * Returns 1 if a given section is present in the configuration.
+ * Returns if a given section is present in the configuration.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section the section to check if exists @notnil
+ * @return 1 if it exists, 0 otherwise 
 **/
-LINPHONE_PUBLIC int linphone_config_has_section(const LinphoneConfig *lpconfig, const char *section);
+LINPHONE_PUBLIC int linphone_config_has_section(const LinphoneConfig *config, const char *section);
 
 /**
  * Removes every pair of key,value in a section and remove the section.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section the section to clean @notnil
 **/
-LINPHONE_PUBLIC void linphone_config_clean_section(LinphoneConfig *lpconfig, const char *section);
+LINPHONE_PUBLIC void linphone_config_clean_section(LinphoneConfig *config, const char *section);
 
 /**
- * Returns 1 if a given section  with a given key is present in the configuration.
- * @param[in] lpconfig The #LinphoneConfig object
- * @param[in] section
- * @param[in] key
+ * Returns if a given section  with a given key is present in the configuration.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section to check if the given entry exists @notnil
+ * @param key to check if it exists @notnil
+ * @return 1 if it exists, 0 otherwise
  **/
-LINPHONE_PUBLIC int linphone_config_has_entry(const LinphoneConfig *lpconfig, const char *section, const char *key);
+LINPHONE_PUBLIC int linphone_config_has_entry(const LinphoneConfig *config, const char *section, const char *key);
 
 /**
  * Removes entries for key,value in a section.
- * @param[in] lpconfig The #LinphoneConfig object
- * @param[in] section
- * @param[in] key
+ * @param config The #LinphoneConfig object @notnil
+ * @param section the section for which to clean the key entry @notnil
+ * @param key the key to clean @notnil
  **/
-LINPHONE_PUBLIC void linphone_config_clean_entry(LinphoneConfig *lpconfig, const char *section, const char *key);
+LINPHONE_PUBLIC void linphone_config_clean_entry(LinphoneConfig *config, const char *section, const char *key);
 
 /**
  * Returns the list of sections' names in the LinphoneConfig.
- * @param[in] lpconfig The #LinphoneConfig object
- * @return a null terminated static array of strings
- * @deprecated use linphone_config_get_sections_names_list instead
- * @donotwrap
+ * @param config The #LinphoneConfig object @notnil
+ * @return A list of strings. \bctbx_list{char *} @maybenil
 **/
-LINPHONE_PUBLIC const char** linphone_config_get_sections_names(LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_sections_names_list(LinphoneConfig *config);
 
 /**
- * Returns the list of sections' names in the LinphoneConfig.
- * @param[in] lpconfig The #LinphoneConfig object
- * @return \bctbx_list{char *} a null terminated static array of strings
+ * Returns the list of keys' names for a section in the LinphoneConfig.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section name @notnil
+ * @return A list of strings. \bctbx_list{char *} @maybenil
 **/
-LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_sections_names_list(LpConfig *lpconfig);
+LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_keys_names_list(LinphoneConfig *config, const char *section );
 
 /**
  * @brief Call a function for each section present in the configuration.
  * @donotwrap
 **/
-void linphone_config_for_each_section(const LinphoneConfig *lpconfig, void (*callback)(const char *section, void *ctx), void *ctx);
+void linphone_config_for_each_section(const LinphoneConfig *config, void (*callback)(const char *section, void *ctx), void *ctx);
 
 /**
  * @brief Call a function for each entry present in a section configuration.
  * @donotwrap
 **/
-void linphone_config_for_each_entry(const LinphoneConfig *lpconfig, const char *section, void (*callback)(const char *entry, void *ctx), void *ctx);
+void linphone_config_for_each_entry(const LinphoneConfig *config, const char *section, void (*callback)(const char *entry, void *ctx), void *ctx);
 
 /*tells whether uncommited (with linphone_config_sync()) modifications exist*/
-bool_t linphone_config_needs_commit(const LinphoneConfig *lpconfig);
+bool_t linphone_config_needs_commit(const LinphoneConfig *config);
 
 LINPHONE_PUBLIC void linphone_config_destroy(LinphoneConfig *cfg);
 
 /**
  * Retrieves a default configuration item as an integer, given its section, key, and default value.
  * The default integer value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the default value @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found default value or default_value if not found.
 **/
-LINPHONE_PUBLIC int linphone_config_get_default_int(const LinphoneConfig *lpconfig, const char *section, const char *key, int default_value);
+LINPHONE_PUBLIC int linphone_config_get_default_int(const LinphoneConfig *config, const char *section, const char *key, int default_value);
 
 /**
  * Retrieves a default configuration item as a 64 bit integer, given its section, key, and default value.
  * The default integer value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the default value @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found default value or default_value if not found.
 **/
-LINPHONE_PUBLIC int64_t linphone_config_get_default_int64(const LinphoneConfig *lpconfig, const char *section, const char *key, int64_t default_value);
+LINPHONE_PUBLIC int64_t linphone_config_get_default_int64(const LinphoneConfig *config, const char *section, const char *key, int64_t default_value);
 
 /**
  * Retrieves a default configuration item as a float, given its section, key, and default value.
  * The default float value is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the default value @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found default value or default_value if not found.
 **/
-LINPHONE_PUBLIC float linphone_config_get_default_float(const LinphoneConfig *lpconfig, const char *section, const char *key, float default_value);
+LINPHONE_PUBLIC float linphone_config_get_default_float(const LinphoneConfig *config, const char *section, const char *key, float default_value);
 
 /**
  * Retrieves a default configuration item as a string, given its section, key, and default value.
  * The default value string is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the default value @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found
+ * @return the found default value or default_value if not found.
 **/
-LINPHONE_PUBLIC const char* linphone_config_get_default_string(const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_value);
+LINPHONE_PUBLIC const char* linphone_config_get_default_string(const LinphoneConfig *config, const char *section, const char *key, const char *default_value);
 
 /**
  * Retrieves a section parameter item as a string, given its section and key.
  * The default value string is returned if the config item isn't found.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the default value @notnil
+ * @param key The name of the configuration item to retrieve @notnil
+ * @param default_value The default value to return if not found. @maybenil
+ * @return the found default value or default_value if not found. @maybenil
 **/
-LINPHONE_PUBLIC const char* linphone_config_get_section_param_string(const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_value);
+LINPHONE_PUBLIC const char* linphone_config_get_section_param_string(const LinphoneConfig *config, const char *section, const char *key, const char *default_value);
 
 /**
  * increment reference count
+ * @param config The #LinphoneConfig object @notnil
+ * @return the same #LinphoneConfig object @notnil
 **/
-LINPHONE_PUBLIC LinphoneConfig *linphone_config_ref(LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC LinphoneConfig *linphone_config_ref(LinphoneConfig *config);
 
 /**
  * Decrement reference count, which will eventually free the object.
+ * @param config The #LinphoneConfig object @notnil
 **/
-LINPHONE_PUBLIC void linphone_config_unref(LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC void linphone_config_unref(LinphoneConfig *config);
 
 /**
  * Write a string in a file placed relatively with the Linphone configuration file.
- * @param lpconfig #LinphoneConfig instance used as a reference
- * @param filename Name of the file where to write data. The name is relative to the place of the config file
- * @param data String to write
+ * @param config #LinphoneConfig instance used as a reference @notnil
+ * @param filename Name of the file where to write data. The name is relative to the place of the config file @notnil
+ * @param data String to write @notnil
  */
-LINPHONE_PUBLIC void linphone_config_write_relative_file(const LinphoneConfig *lpconfig, const char *filename, const char *data);
+LINPHONE_PUBLIC void linphone_config_write_relative_file(const LinphoneConfig *config, const char *filename, const char *data);
 
 /**
  * Read a string from a file placed beside the Linphone configuration file
- * @param lpconfig #LinphoneConfig instance used as a reference
+ * @param config #LinphoneConfig instance used as a reference
  * @param filename Name of the file where data will be read from. The name is relative to the place of the config file
  * @param data Buffer where read string will be stored
  * @param max_length Length of the buffer
  * @return 0 on success, -1 on failure
  * @donotwrap
  */
-LINPHONE_PUBLIC LinphoneStatus linphone_config_read_relative_file(const LinphoneConfig *lpconfig, const char *filename, char *data, size_t max_length);
+LINPHONE_PUBLIC LinphoneStatus linphone_config_read_relative_file(const LinphoneConfig *config, const char *filename, char *data, size_t max_length);
 
 /**
+ * Check if given file name exists relatively to the current location
+ * @param config The #LinphoneConfig object @notnil
+ * @param filename The file name to check if exists @notnil
  * @return TRUE if file exists relative to the to the current location
 **/
-LINPHONE_PUBLIC bool_t linphone_config_relative_file_exists(const LinphoneConfig *lpconfig, const char *filename);
+LINPHONE_PUBLIC bool_t linphone_config_relative_file_exists(const LinphoneConfig *config, const char *filename);
 
 /**
  * Dumps the #LinphoneConfig as XML into a buffer
- * @param[in] lpconfig The #LinphoneConfig object
- * @return The buffer that contains the XML dump
+ * @param config The #LinphoneConfig object @notnil
+ * @return The buffer that contains the XML dump @notnil
 **/
-LINPHONE_PUBLIC char* linphone_config_dump_as_xml(const LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC char* linphone_config_dump_as_xml(const LinphoneConfig *config);
 
 /**
  * Dumps the #LinphoneConfig as INI into a buffer
- * @param[in] lpconfig The #LinphoneConfig object
- * @return The buffer that contains the config dump
+ * @param config The #LinphoneConfig object @notnil
+ * @return The buffer that contains the config dump @notnil
 **/
-LINPHONE_PUBLIC char* linphone_config_dump(const LinphoneConfig *lpconfig);
+LINPHONE_PUBLIC char* linphone_config_dump(const LinphoneConfig *config);
 
 /**
  * Retrieves the overwrite flag for a config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the overwrite flag @notnil
+ * @param key The name of the configuration item to retrieve the overwrite flag from. @notnil
+ * @return TRUE if overwrite flag is set, FALSE otherwise.
 **/
-LINPHONE_PUBLIC bool_t linphone_config_get_overwrite_flag_for_entry(const LinphoneConfig *lpconfig, const char *section, const char *key);
+LINPHONE_PUBLIC bool_t linphone_config_get_overwrite_flag_for_entry(const LinphoneConfig *config, const char *section, const char *key);
 
 /**
  * Sets the overwrite flag for a config item (used when dumping config as xml)
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to set the overwrite flag @notnil
+ * @param key The name of the configuration item to set the overwrite flag from @notnil
+ * @param value The overwrite flag value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_overwrite_flag_for_entry(LinphoneConfig *lpconfig, const char *section, const char *key, bool_t value);
+LINPHONE_PUBLIC void linphone_config_set_overwrite_flag_for_entry(LinphoneConfig *config, const char *section, const char *key, bool_t value);
 
 /**
  * Retrieves the overwrite flag for a config section
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the overwrite flag @notnil
+ * @return TRUE if overwrite flag is set, FALSE otherwise.
 **/
-LINPHONE_PUBLIC bool_t linphone_config_get_overwrite_flag_for_section(const LinphoneConfig *lpconfig, const char *section);
+LINPHONE_PUBLIC bool_t linphone_config_get_overwrite_flag_for_section(const LinphoneConfig *config, const char *section);
 
 /**
  * Sets the overwrite flag for a config section (used when dumping config as xml)
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to set the overwrite flag @notnil
+ * @param value The overwrite flag value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_overwrite_flag_for_section(LinphoneConfig *lpconfig, const char *section, bool_t value);
+LINPHONE_PUBLIC void linphone_config_set_overwrite_flag_for_section(LinphoneConfig *config, const char *section, bool_t value);
 
 /**
  * Retrieves the skip flag for a config item
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the skip flag @notnil
+ * @param key The name of the configuration item to retrieve the skip flag from
+ * @return TRUE if skip flag is set, FALSE otherwise.
 **/
-LINPHONE_PUBLIC bool_t linphone_config_get_skip_flag_for_entry(const LinphoneConfig *lpconfig, const char *section, const char *key);
+LINPHONE_PUBLIC bool_t linphone_config_get_skip_flag_for_entry(const LinphoneConfig *config, const char *section, const char *key);
 
 /**
  * Sets the skip flag for a config item (used when dumping config as xml)
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to set the skip flag @notnil
+ * @param key The name of the configuration item to set the skip flag from @notnil
+ * @param value The skip flag value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_skip_flag_for_entry(LinphoneConfig *lpconfig, const char *section, const char *key, bool_t value);
+LINPHONE_PUBLIC void linphone_config_set_skip_flag_for_entry(LinphoneConfig *config, const char *section, const char *key, bool_t value);
 
 /**
  * Retrieves the skip flag for a config section
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to retrieve the skip flag @notnil
+ * @return TRUE if skip flag is set, FALSE otherwise.
 **/
-LINPHONE_PUBLIC bool_t linphone_config_get_skip_flag_for_section(const LinphoneConfig *lpconfig, const char *section);
+LINPHONE_PUBLIC bool_t linphone_config_get_skip_flag_for_section(const LinphoneConfig *config, const char *section);
 
 /**
  * Sets the skip flag for a config section (used when dumping config as xml)
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section from which to set the skip flag @notnil
+ * @param value The skip flag value to set
 **/
-LINPHONE_PUBLIC void linphone_config_set_skip_flag_for_section(LinphoneConfig *lpconfig, const char *section, bool_t value);
+LINPHONE_PUBLIC void linphone_config_set_skip_flag_for_section(LinphoneConfig *config, const char *section, bool_t value);
 
 /**
  * Converts a config section into a dictionary.
- * @return a dictionary with all the keys from a section, or NULL if the section doesn't exist
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section to dump as dictionary @notnil
+ * @return a dictionary with all the keys from a section, or NULL if the section doesn't exist. @maybenil
+ * @donotwrap LinphoneDictionary can't be wrapped
  */
-LINPHONE_PUBLIC LinphoneDictionary * lp_config_section_to_dict( const LpConfig* lpconfig, const char* section );
+LINPHONE_PUBLIC LinphoneDictionary * linphone_config_section_to_dict(const LinphoneConfig* config, const char* section);
 
 /**
- * Loads a dictionary into a section of the lpconfig. If the section doesn't exist it is created.
+ * Loads a dictionary into a section of the #LinphoneConfig. If the section doesn't exist it is created.
  * Overwrites existing keys, creates non-existing keys.
+ * @param config The #LinphoneConfig object @notnil
+ * @param section The section to dump as dictionary @notnil
+ * @param dict the dictionnary to load into the section @notnil
+ * @donotwrap LinphoneDictionary can't be wrapped
  */
-LINPHONE_PUBLIC void lp_config_load_dict_to_section( LpConfig* lpconfig, const char* section, const LinphoneDictionary* dict);
+LINPHONE_PUBLIC void linphone_config_load_dict_to_section(LinphoneConfig* config, const char* section, const LinphoneDictionary* dict);
+
+/************ */
+/* DEPRECATED */
+/* ********** */
+
+/**
+ * Returns the list of sections' names in the LinphoneConfig.
+ * @param config The #LinphoneConfig object
+ * @return a null terminated static array of strings
+ * @deprecated 12/10/2017 use linphone_config_get_sections_names_list instead
+ * @donotwrap
+**/
+LINPHONE_PUBLIC const char** linphone_config_get_sections_names(LinphoneConfig *config);
 
 #ifdef __cplusplus
 }
 #endif
 
-// Define old function names for backward compatibility
-#define lp_config_new linphone_config_new
-#define lp_config_new_from_buffer linphone_config_new_from_buffer
-#define lp_config_new_with_factory linphone_config_new_with_factory
-#define lp_config_read_file linphone_config_read_file
-#define lp_config_get_string linphone_config_get_string
-#define lp_config_get_string_list linphone_config_get_string_list
-#define lp_config_get_range linphone_config_get_range
-#define lp_config_get_int linphone_config_get_int
-#define lp_config_get_int64 linphone_config_get_int64
-#define lp_config_get_float linphone_config_get_float
-#define lp_config_set_string linphone_config_set_string
-#define lp_config_set_string_list linphone_config_set_string_list
-#define lp_config_set_range linphone_config_set_range
-#define lp_config_set_int linphone_config_set_int
-#define lp_config_set_int_hex linphone_config_set_int_hex
-#define lp_config_set_int64 linphone_config_set_int64
-#define lp_config_set_float linphone_config_set_float
-#define lp_config_sync linphone_config_sync
-#define lp_config_has_section linphone_config_has_section
-#define lp_config_clean_section linphone_config_clean_section
-#define lp_config_has_entry linphone_config_has_entry
-#define lp_config_clean_entry linphone_config_clean_entry
-#define lp_config_get_sections_names linphone_config_get_sections_names
-#define lp_config_for_each_section linphone_config_for_each_section
-#define lp_config_for_each_entry linphone_config_for_each_entry
-#define lp_config_needs_commit linphone_config_needs_commit
-#define lp_config_destroy linphone_config_destroy
-#define lp_config_get_default_int linphone_config_get_default_int
-#define lp_config_get_default_int64 linphone_config_get_default_int64
-#define lp_config_get_default_float linphone_config_get_default_float
-#define lp_config_get_default_string linphone_config_get_default_string
-#define lp_config_get_section_param_string linphone_config_get_section_param_string
-#define lp_config_ref linphone_config_ref
-#define lp_config_unref linphone_config_unref
-#define lp_config_write_relative_file linphone_config_write_relative_file
-#define lp_config_read_relative_file linphone_config_read_relative_file
-#define lp_config_relative_file_exists linphone_config_relative_file_exists
-#define lp_config_dump_as_xml linphone_config_dump_as_xml
-#define lp_config_dump linphone_config_dump
-#define lp_config_get_overwrite_flag_for_entry linphone_config_get_overwrite_flag_for_entry
-#define lp_config_set_overwrite_flag_for_entry linphone_config_set_overwrite_flag_for_entry
-#define lp_config_get_overwrite_flag_for_section linphone_config_get_overwrite_flag_for_section
-#define lp_config_set_overwrite_flag_for_section linphone_config_set_overwrite_flag_for_section
-#define lp_config_get_skip_flag_for_entry linphone_config_get_skip_flag_for_entry
-#define lp_config_set_skip_flag_for_entry linphone_config_set_skip_flag_for_entry
-#define lp_config_get_skip_flag_for_section linphone_config_get_skip_flag_for_section
-#define lp_config_set_skip_flag_for_section linphone_config_set_skip_flag_for_section
+// 08/07/2020 Define old function names for backward compatibility
+#define lp_config_section_to_dict linphone_config_section_to_dict
+#define lp_config_load_dict_to_section linphone_config_load_dict_to_section
 
 /**
  * @}

--
Gitblit v1.8.0