From 8417e3485ed35538133ce01d1870456941270db1 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:35:11 +0200 Subject: libsmbconf: Document smbconf_get_parameter(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'lib/smbconf') 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, -- cgit