summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2012-12-11 17:11:58 +0100
committerAndreas Schneider <asn@cryptomilk.org>2012-12-12 14:58:50 +0100
commitc9053796b389758e8bacff4cd37d633fd65171f9 (patch)
treeddf9eefade5dc13de02d9b541be50741b6651dfe
parent7f08365a28770fdcc1bb625d8a16d11d8f15c29a (diff)
downloadsamba-c9053796b389758e8bacff4cd37d633fd65171f9.tar.gz
samba-c9053796b389758e8bacff4cd37d633fd65171f9.tar.bz2
samba-c9053796b389758e8bacff4cd37d633fd65171f9.zip
tdb: Improve the documentation of tdb_reopen() and tdb_close().
Reviewed-by: Simo Sorce <idra@samba.org> Autobuild-User(master): Andreas Schneider <asn@cryptomilk.org> Autobuild-Date(master): Wed Dec 12 14:58:50 CET 2012 on sn-devel-104
-rw-r--r--lib/tdb/include/tdb.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/tdb/include/tdb.h b/lib/tdb/include/tdb.h
index d19439e760..e371e33876 100644
--- a/lib/tdb/include/tdb.h
+++ b/lib/tdb/include/tdb.h
@@ -212,9 +212,12 @@ void tdb_set_max_dead(struct tdb_context *tdb, int max_dead);
* This can be used after a fork to ensure that we have an independent seek
* pointer from our parent and to re-establish locks.
*
- * @param[in] tdb The database to reopen.
+ * @param[in] tdb The database to reopen. It will be free'd on error!
*
* @return 0 on success, -1 on error.
+ *
+ * @note Don't call tdb_error() after this function cause the tdb context will
+ * be freed on error.
*/
int tdb_reopen(struct tdb_context *tdb);
@@ -361,9 +364,12 @@ int tdb_append(struct tdb_context *tdb, TDB_DATA key, TDB_DATA new_dbuf);
/**
* @brief Close a database.
*
- * @param[in] tdb The database to close.
+ * @param[in] tdb The database to close. The context will be free'd.
*
* @return 0 for success, -1 on error.
+ *
+ * @note Don't call tdb_error() after this function cause the tdb context will
+ * be freed on error.
*/
int tdb_close(struct tdb_context *tdb);