lib: make notmuch_query_add_tag_exclude return a status value

[notmuch] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index e692e9bbe85d71b7f7b8b9aeb7e40826ca229cba..d374dc960fe67b4ccc1b096dc41c240d0779d808 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -179,6 +179,11 @@ typedef enum _notmuch_status {
      * passed to a function expecting an absolute path.
      */
     NOTMUCH_STATUS_PATH_ERROR,
      * passed to a function expecting an absolute path.
      */
     NOTMUCH_STATUS_PATH_ERROR,

+    /**
+     * The requested operation was ignored. Depending on the function,
+     * this may not be an actual error.
+     */
+    NOTMUCH_STATUS_IGNORED,

     /**
      * One of the arguments violates the preconditions for the
      * function, in a way not covered by a more specific argument.
     /**
      * One of the arguments violates the preconditions for the
      * function, in a way not covered by a more specific argument.


@@ -812,10 +817,20 @@ notmuch_query_get_sort (const notmuch_query_t *query);
 
 /**
  * Add a tag that will be excluded from the query results by default.
 
 /**
  * Add a tag that will be excluded from the query results by default.

- * This exclusion will be overridden if this tag appears explicitly in
+ * This exclusion will be ignored if this tag appears explicitly in

  * the query.
  * the query.

+ *
+ * @returns
+ *
+ * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
+ *
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
+ *      Most likely a problem lazily parsing the query string.
+ *
+ * NOTMUCH_STATUS_IGNORED: tag is explicitely present in the query, so
+ *             not excluded.

  */
  */

-void
+notmuch_status_t

 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
 
 /**
 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
 
 /**