From d70acdc554d6bbab367d7e0ebb0a255f528b94ed Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:37:59 +0200 Subject: libsmbconf: Document smbconf_delete_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 fb3e027107..9bb911dc58 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -310,8 +310,21 @@ sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx, const char *param, char **valstr); +/** + * @brief Delete a parameter from the configuration. + * + * @param[in] ctx The smbconf context to use. + * + * @param[in] service The service where the parameter can be found. + * + * @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_parameter(struct smbconf_ctx *ctx, const char *service, const char *param); + sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx, const char *param); sbcErr smbconf_get_includes(struct smbconf_ctx *ctx, -- cgit