diff options
| author | Dmitri Pal <dpal@redhat.com> | 2010-03-11 12:28:40 -0500 |
|---|---|---|
| committer | Stephen Gallagher <sgallagh@redhat.com> | 2010-03-17 12:03:58 -0400 |
| commit | 468ebea67beec7215506125c5a4fbad35e12adc3 (patch) | |
| tree | 67bb504010eceacb56323c485e3de6d85cfa864d /ini/ini_config.h | |
| parent | 885d8e5c7cd6e27643a70c35a52de0ece0901e1f (diff) | |
| download | ding-libs-468ebea67beec7215506125c5a4fbad35e12adc3.tar.gz ding-libs-468ebea67beec7215506125c5a4fbad35e12adc3.tar.xz ding-libs-468ebea67beec7215506125c5a4fbad35e12adc3.zip | |
Fixing type conversion in INI interface.
Additional changes.
Diffstat (limited to 'ini/ini_config.h')
| -rw-r--r-- | ini/ini_config.h | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/ini/ini_config.h b/ini/ini_config.h index 9072203..da8227b 100644 --- a/ini/ini_config.h +++ b/ini/ini_config.h @@ -1040,6 +1040,10 @@ void free_bin_config_value(char *bin); * Size and error parameters can be NULL. * Use \ref free_string_config_array() to free the array after use. * + * The array is always NULL terminated so + * it is safe not to get size and just loop until + * array element is NULL. + * * @param[in] item Item to interpret. * It must be retrieved using * \ref get_config_item(). @@ -1095,6 +1099,10 @@ char **get_string_config_array(struct collection_item *item, * Size and error parameters can be NULL. * Use \ref free_string_config_array() to free the array after use. * + * The array is always NULL terminated so + * it is safe not to get size and just loop until + * array element is NULL. + * * @param[in] item Item to interpret. * It must be retrieved using * \ref get_config_item(). @@ -1142,13 +1150,14 @@ char **get_raw_string_config_array(struct collection_item *item, * in the string. * * The length of the allocated array is returned in "size". - * Size and error parameters can be NULL. + * Size parameter can't be NULL. + * * Use \ref free_long_config_array() to free the array after use. * * @param[in] item Item to interpret. * It must be retrieved using * \ref get_config_item(). - * @param[out] size Variable that optionally receives + * @param[out] size Variable that receives * the size of the array. * @param[out] error Variable will get the value * of the error code if @@ -1187,13 +1196,14 @@ long *get_long_config_array(struct collection_item *item, * in the string. * * The length of the allocated array is returned in "size". - * Size and error parameters can be NULL. + * Size parameter can't be NULL. + * * Use \ref free_double_config_array() to free the array after use. * * @param[in] item Item to interpret. * It must be retrieved using * \ref get_config_item(). - * @param[out] size Variable that optionally receives + * @param[out] size Variable that receives * the size of the array. * @param[out] error Variable will get the value * of the error code if |