From 9bbf4bd0f32bd950d94460f751052480d09e711a Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:53:25 +0200 Subject: libsmbconf: Document smbconf_transaction_commit(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'lib/smbconf') diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index c3cd2b34ed..fffdd7613e 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -447,7 +447,20 @@ sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx); */ sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx); +/** + * @brief Commit a transaction on the configuration backend. + * + * This is to speed up writes to the registry based backend. + * + * @param[in] ctx The smbconf context to commit the transaction. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + * + * @see smbconf_transaction_start() + */ sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx); + sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx); #endif /* _LIBSMBCONF_H_ */ -- cgit