aboutsummaryrefslogtreecommitdiff
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2021-03-14 11:01:59 -0300
committerDavid Bremner <david@tethera.net>2021-03-18 08:04:06 -0300
commit13efbd0e1c88fcbdb48b4c30c7852c5bf1fbd0b7 (patch)
tree601d78a964f42acf4c3d41b813e70fadc27eda82 /lib/notmuch.h
parentf0717aa380cfa84c1973f7b03948d93b261a73fe (diff)
lib: support reopening databases for write access.
In the future Xapian will apparently support this more conveniently for the cases other than READ_ONLY => READ_ONLY Conceptually this function seems to fit better in lib/open.cc; database.cc is still large enough that moving the function makes sense.
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index db86ffc0..b5688087 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -882,6 +882,12 @@ notmuch_database_get_all_tags (notmuch_database_t *db);
/**
* Reopen an open notmuch database.
*
+ * @param [in] db open notmuch database
+ * @param [in] mode mode (read only or read-write) for reopened database.
+ *
+ * @retval #NOTMUCH_STATUS_SUCCESS
+ * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
+ * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
*/
notmuch_status_t
notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);