From 1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:36:36 +0200 Subject: libsmbconf: Document smbconf_get_global_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 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, -- cgit