summaryrefslogtreecommitdiffstats
path: root/lib/smbconf/smbconf.h
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:31:17 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commit62f3560e988a04db5b8baf40aba47735204ab05e (patch)
tree9b89f48dfdfce098533f76db58c0da68179566a1 /lib/smbconf/smbconf.h
parent7e04bd1f857d9a14b38795dbeba8e23f1326c229 (diff)
downloadsamba-62f3560e988a04db5b8baf40aba47735204ab05e.tar.gz
samba-62f3560e988a04db5b8baf40aba47735204ab05e.tar.xz
samba-62f3560e988a04db5b8baf40aba47735204ab05e.zip
libsmbconf: Document smbconf_set_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib/smbconf/smbconf.h')
-rw-r--r--lib/smbconf/smbconf.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 5d8ce70351..2f1affaa15 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,