summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:35:11 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commit8417e3485ed35538133ce01d1870456941270db1 (patch)
tree54fa0be589656ddf70b873d1732677563bbeb1e6
parent70c5143ea49f9abe3a71947664ff488932eb8f58 (diff)
downloadsamba-8417e3485ed35538133ce01d1870456941270db1.tar.gz
samba-8417e3485ed35538133ce01d1870456941270db1.tar.bz2
samba-8417e3485ed35538133ce01d1870456941270db1.zip
libsmbconf: Document smbconf_get_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 6bc00d43ff..83f62746ec 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -267,11 +267,28 @@ sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx,
sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx,
const char *param, const char *val);
+/**
+ * @brief Get the value of a configuration parameter as a string.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] mem_ctx The memory context to allocate the string on.
+ *
+ * @param[in] service The name of the service where to find the parameter.
+ *
+ * @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_parameter(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *service,
const char *param,
char **valstr);
+
sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *param,