summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:36:36 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commit1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850 (patch)
tree615d2e148c7b93b524b91ed6472730f951f6de2b
parent8417e3485ed35538133ce01d1870456941270db1 (diff)
downloadsamba-1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850.tar.gz
samba-1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850.tar.bz2
samba-1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850.zip
libsmbconf: Document smbconf_get_global_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r--lib/smbconf/smbconf.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 83f62746ec..fb3e027107 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -289,10 +289,27 @@ sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx,
const char *param,
char **valstr);
+/**
+ * @brief Get the value of a global configuration parameter as a string.
+ *
+ * It also creates [global] if it does't exist.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] mem_ctx The memory context to allocate the string on.
+ *
+ * @param[in] param The parameter to get.
+ *
+ * @param[out] valstr A pointer to store the value as a string.
+ *
+ * @return SBC_ERR_OK on success, a corresponding sbcErr if an
+ * error occured.
+ */
sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *param,
char **valstr);
+
sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx,
const char *service, const char *param);
sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx,