summaryrefslogtreecommitdiffstats
path: root/lib/smbconf/smbconf.h
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:32:06 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commit70c5143ea49f9abe3a71947664ff488932eb8f58 (patch)
treec3f26f83916e3bf5af3dd8a5e175b3eba09bf1a8 /lib/smbconf/smbconf.h
parent62f3560e988a04db5b8baf40aba47735204ab05e (diff)
downloadsamba-70c5143ea49f9abe3a71947664ff488932eb8f58.tar.gz
samba-70c5143ea49f9abe3a71947664ff488932eb8f58.tar.xz
samba-70c5143ea49f9abe3a71947664ff488932eb8f58.zip
libsmbconf: Document smbconf_set_global_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib/smbconf/smbconf.h')
-rw-r--r--lib/smbconf/smbconf.h16
1 files changed, 16 insertions, 0 deletions
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,