From 938690c77135b5a909d48654d10955bc037a0b38 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:13:49 +0200 Subject: libsmbconf: Document smbconf_drop(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'lib/smbconf') diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 5c0f84d172..c15cd5c0c0 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -121,7 +121,16 @@ void smbconf_shutdown(struct smbconf_ctx *ctx); bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn, const char *service, const char *param); +/** + * @brief Drop the whole configuration (restarting empty). + * + * @param[in] ctx The smbconf context to drop the config. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_drop(struct smbconf_ctx *ctx); + sbcErr smbconf_get_config(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, uint32_t *num_shares, -- cgit