From 24af63e25f11fde79b1675f0d3c6e3b10fc69a04 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:32:06 +0200 Subject: [PATCH] libsmbconf: Document smbconf_set_global_parameter(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 2f1affaa159..6bc00d43ff7 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -249,8 +249,24 @@ sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx, const char *param, const char *valstr); +/** + * @brief Set a global configuration parameter to the value provided. + * + * This adds a paramet in the [global] service. 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 set. + * + * @param[in] val The value to set. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx, const char *param, const char *val); + sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *service, -- 2.11.4.GIT