From b7ba46d1c0e1fdd5b68dd0478d38a633938aae84 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:38:31 +0200 Subject: libsmbconf: Document smbconf_delete_global_parameter(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'lib/smbconf') 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, -- cgit