summaryrefslogtreecommitdiff
path: root/lib/smbconf
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:54:11 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:25 +0200
commit60109a0e6d30ea3bd33de03ac3c958ded7aeee89 (patch)
treef92e45553f8ab6ccff61460697df0c57bf348fc2 /lib/smbconf
parent9bbf4bd0f32bd950d94460f751052480d09e711a (diff)
downloadsamba-60109a0e6d30ea3bd33de03ac3c958ded7aeee89.tar.gz
samba-60109a0e6d30ea3bd33de03ac3c958ded7aeee89.tar.bz2
samba-60109a0e6d30ea3bd33de03ac3c958ded7aeee89.zip
libsmbconf: Document smbconf_transaction_cancel().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib/smbconf')
-rw-r--r--lib/smbconf/smbconf.h10
1 files changed, 10 insertions, 0 deletions
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_ */