]> git.notmuchmail.org Git - notmuch/blobdiff - lib/notmuch.h
lib: Ensure notmuch_query_search_messages returns NULL on an exception.
[notmuch] / lib / notmuch.h
index 921b0fcfa519ee3f4eb54827ad1ac92d64a4c8c4..505ad19fe90470c958fa9d59805af929b588af8e 100644 (file)
@@ -439,6 +439,8 @@ notmuch_query_search_threads (notmuch_query_t *query);
  * notmuch_messages_t object. (For consistency, we do provide a
  * notmuch_messages_destroy function, but there's no good
  * reason to call it if the query is about to be destroyed).
+ *
+ * If a Xapian exception occurs this function will return NULL.
  */
 notmuch_messages_t *
 notmuch_query_search_messages (notmuch_query_t *query);
@@ -506,6 +508,9 @@ notmuch_threads_destroy (notmuch_threads_t *threads);
  *
  * This function performs a search and returns Xapian's best
  * guess as to number of matching messages.
+ *
+ * If a Xapian exception occurs, this function may return 0 (after
+ * printing a message).
  */
 unsigned
 notmuch_query_count_messages (notmuch_query_t *query);