summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:22:25 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:23 +0200
commit211286042d4679b85ad1977af3ae8dd0245b4b43 (patch)
tree52e04764d2401b496ae24161a97a2855d862378a
parent87c40960922cafe0e5fe6f027d878eefebe82c03 (diff)
downloadsamba-211286042d4679b85ad1977af3ae8dd0245b4b43.tar.gz
samba-211286042d4679b85ad1977af3ae8dd0245b4b43.tar.bz2
samba-211286042d4679b85ad1977af3ae8dd0245b4b43.zip
libsmbconf: Document smbconf_get_share_names().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r--lib/smbconf/smbconf.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 000d5ccf59..0a46874fc5 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,