From e8181a4c66edda0bfce17a4b98a3a07e6ec56254 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:22:25 +0200 Subject: [PATCH] libsmbconf: Document smbconf_get_share_names(). Signed-off-by: Michael Adam (cherry picked from commit 32bafa560b4b76e9f01e1e82fd18168ba4266081) --- lib/smbconf/smbconf.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 000d5ccf597..0a46874fc5b 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -153,10 +153,25 @@ sbcErr smbconf_get_config(struct smbconf_ctx *ctx, uint32_t *num_shares, struct smbconf_service ***services); +/** + * @brief Get the list of share names defined in the configuration. + * + * @param[in] ctx The smbconf context to use. + * + * @param[in] mem_ctx The memory context to use. + * + * @param[in] num_shares A pointer to store the number of shares. + * + * @param[in] share_names A pointer to store the share names. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_get_share_names(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, uint32_t *num_shares, char ***share_names); + bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename); sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename); sbcErr smbconf_get_share(struct smbconf_ctx *ctx, -- 2.11.4.GIT