From 60109a0e6d30ea3bd33de03ac3c958ded7aeee89 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:54:11 +0200 Subject: libsmbconf: Document smbconf_transaction_cancel(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'lib/smbconf') diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index fffdd7613e..4c2bacf87f 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -461,6 +461,16 @@ sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx); */ sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx); +/** + * @brief Cancel a transaction on the configuration backend. + * + * @param[in] ctx The smbconf context to cancel the transaction. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + * + * @see smbconf_transaction_start() + */ sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx); #endif /* _LIBSMBCONF_H_ */ -- cgit