summaryrefslogtreecommitdiffstats
path: root/common/ini/ini_config.h
diff options
context:
space:
mode:
authorDmitri Pal <dpal@redhat.com>2010-03-11 12:28:40 -0500
committerStephen Gallagher <sgallagh@redhat.com>2010-03-17 12:05:11 -0400
commit4bdc6fd0bb6ec48dcfd0c2eb214b6c89f40567a3 (patch)
tree88d7191eeef7a08d33081b7e34af54cb874f654c /common/ini/ini_config.h
parent46c0417d7d8e36348735f03b03c35d5cd5acd3fe (diff)
downloadsssd-4bdc6fd0bb6ec48dcfd0c2eb214b6c89f40567a3.tar.gz
sssd-4bdc6fd0bb6ec48dcfd0c2eb214b6c89f40567a3.tar.xz
sssd-4bdc6fd0bb6ec48dcfd0c2eb214b6c89f40567a3.zip
Fixing type conversion in INI interface.
Additional changes.
Diffstat (limited to 'common/ini/ini_config.h')
-rw-r--r--common/ini/ini_config.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/common/ini/ini_config.h b/common/ini/ini_config.h
index 907220334..da8227b55 100644
--- a/common/ini/ini_config.h
+++ b/common/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