From 9adfc49801340fb9bb3a1d558387502e232efa2e Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:31:17 +0200 Subject: [PATCH] libsmbconf: Document smbconf_set_parameter(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 5d8ce703513..2f1affaa159 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -230,10 +230,25 @@ sbcErr smbconf_get_share(struct smbconf_ctx *ctx, sbcErr smbconf_delete_share(struct smbconf_ctx *ctx, const char *servicename); +/** + * @brief Set a configuration parameter to the value provided. + * + * @param[in] ctx The smbconf context to use. + * + * @param[in] service The service name to set the parameter. + * + * @param[in] param The name of the parameter to set. + * + * @param[in] valstr The value to set. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx, const char *service, const char *param, const char *valstr); + sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx, const char *param, const char *val); sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx, -- 2.34.1