diff options
author | Andreas Schneider <asn@samba.org> | 2011-04-14 11:32:06 +0200 |
---|---|---|
committer | Michael Adam <obnox@samba.org> | 2011-05-10 19:13:24 +0200 |
commit | 70c5143ea49f9abe3a71947664ff488932eb8f58 (patch) | |
tree | c3f26f83916e3bf5af3dd8a5e175b3eba09bf1a8 | |
parent | 62f3560e988a04db5b8baf40aba47735204ab05e (diff) | |
download | samba-70c5143ea49f9abe3a71947664ff488932eb8f58.tar.gz samba-70c5143ea49f9abe3a71947664ff488932eb8f58.tar.bz2 samba-70c5143ea49f9abe3a71947664ff488932eb8f58.zip |
libsmbconf: Document smbconf_set_global_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r-- | lib/smbconf/smbconf.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 2f1affaa15..6bc00d43ff 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, |