From addb4d3e2305d6ce72d4ccaef7063080acfcbcb0 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:52:30 +0200 Subject: [PATCH] libsmbconf: Document smbconf_transaction_start(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 0268ad4bd48..c3cd2b34ed9 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -435,7 +435,18 @@ sbcErr smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service); */ sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx); +/** + * @brief Start a transaction on the configuration backend. + * + * This is to speed up writes to the registry based backend. + * + * @param[in] ctx The smbconf context to start the transaction. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx); + sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx); sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx); -- 2.34.1