summaryrefslogtreecommitdiff
path: root/lib/smbconf
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:38:31 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commitb7ba46d1c0e1fdd5b68dd0478d38a633938aae84 (patch)
tree71535c71ecbab0111511eae66321a6d1d880522a /lib/smbconf
parentd70acdc554d6bbab367d7e0ebb0a255f528b94ed (diff)
downloadsamba-b7ba46d1c0e1fdd5b68dd0478d38a633938aae84.tar.gz
samba-b7ba46d1c0e1fdd5b68dd0478d38a633938aae84.tar.bz2
samba-b7ba46d1c0e1fdd5b68dd0478d38a633938aae84.zip
libsmbconf: Document smbconf_delete_global_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib/smbconf')
-rw-r--r--lib/smbconf/smbconf.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 9bb911dc58..49f1b70aa2 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -325,8 +325,21 @@ sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx,
sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx,
const char *service, const char *param);
+/**
+ * @brief Delete a global parameter from the configuration.
+ *
+ * It also creates [global] if it does't exist.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] param The name of the parameter to delete.
+ *
+ * @return SBC_ERR_OK on success, a corresponding sbcErr if an
+ * error occured.
+ */
sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
const char *param);
+
sbcErr smbconf_get_includes(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *service,