debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2025-03-14 03:25:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: Improve documentation of _notmuch_message_create_for_message_id

Browse source 
Clarify the state of the returned message when
_notmuch_message_create_for_message_id returns
NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
This commit is contained in:
Austin Clements 2014-08-04 21:29:16 -04:00 • committed by David Bremner
parent e501a16e71
commit 0c1292051e
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lib/message.cc
View file

@ -193,14 +193,16 @@ _notmuch_message_create (const void *talloc_owner,
* There is already a document with message ID 'message_id' in the
* database. The returned message can be used to query/modify the
* document.
*
* NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
*
* No document with 'message_id' exists in the database. The
* returned message contains a newly created document (not yet
* added to the database) and a document ID that is known not to
* exist in the database. The caller can modify the message, and a
* call to _notmuch_message_sync will add * the document to the
* database.
* exist in the database. This message is "blank"; that is, it
* contains only a message ID and no other metadata. The caller
* can modify the message, and a call to _notmuch_message_sync
* will add the document to the database.
*
* If an error occurs, this function will return NULL and *status
* will be set as appropriate. (The status pointer argument must