summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:27:03 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:24 +0200
commit474805794e5758dc1dd77a8c7a667531c31eb011 (patch)
tree54f4eeeb68bb0be983176132cfc50a4a192e6125
parent529e0645860cf43f8a507c87fa7c581c29fa5987 (diff)
downloadsamba-474805794e5758dc1dd77a8c7a667531c31eb011.tar.gz
samba-474805794e5758dc1dd77a8c7a667531c31eb011.tar.bz2
samba-474805794e5758dc1dd77a8c7a667531c31eb011.zip
libsmbconf: Document smbconf_get_share().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r--lib/smbconf/smbconf.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 8becb5f284..0ceca5a6d4 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -195,10 +195,28 @@ bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
*/
sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
+/**
+ * @brief Get a definition of a share (service) from configuration.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] mem_ctx A memory context to allocate the result.
+ *
+ * @param[in] servicename The service name to get the information from.
+ *
+ * @param[out] service A pointer to store the service information about the
+ * share.
+ *
+ * @return SBC_ERR_OK on success, a corresponding sbcErr if an
+ * error occured.
+ *
+ * @see smbconf_service
+ */
sbcErr smbconf_get_share(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *servicename,
struct smbconf_service **service);
+
sbcErr smbconf_delete_share(struct smbconf_ctx *ctx,
const char *servicename);
sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx,