diff options
| author | Andreas Schneider <asn@samba.org> | 2011-04-14 11:27:03 +0200 |
|---|---|---|
| committer | Karolin Seeger <kseeger@samba.org> | 2011-05-15 20:20:00 +0200 |
| commit | e3dbd1dfed8934bbaa6e8ade2eb8d38d59b36896 (patch) | |
| tree | 5dc79076265e2a524340b905c917cbc9bd83094f /lib | |
| parent | 52d0f7b52084d89cf767c7d59a6c5c38e8fa3840 (diff) | |
| download | samba-e3dbd1dfed8934bbaa6e8ade2eb8d38d59b36896.tar.gz samba-e3dbd1dfed8934bbaa6e8ade2eb8d38d59b36896.tar.xz samba-e3dbd1dfed8934bbaa6e8ade2eb8d38d59b36896.zip | |
libsmbconf: Document smbconf_get_share().
Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit adc8fef73400095e387061b7ccff81059b117326)
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/smbconf/smbconf.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 8becb5f2849..0ceca5a6d45 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, |