debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: update documentation for notmuch_database_get_directory

Browse source 
Clarify that using the directory after destroying the corresponding
database is not permitted.

This is implicit in the description of notmuch_database_destroy, but
it doesn't hurt to be explicit, and we do express similar "ownership"
relationships at other places in the docs.
This commit is contained in:
David Bremner 2014-01-24 23:07:43 -04:00
parent b54e2f4fb1
commit 3b74537f49
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/notmuch.h
View file

@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);
* If this directory object does not exist in the database, this * If this directory object does not exist in the database, this
* returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL. * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
* *
* Otherwise the returned directory object is owned by the database
* and as such, will only be valid until notmuch_database_destroy is
* called.
*
* Return value: * Return value:
* *
* NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory. * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.