X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=lib%2Fnotmuch.h;h=3633bedde20acafc064b62a52f319dcdde153111;hp=e6e5cc2e01ca84f8a739d44fd6bd7f10891c3171;hb=af6b4b29f97b1f457bb7220491bf37536e1b9d7a;hpb=ba5729421825e0ec9d38aa9d656553f329aa6f09 diff --git a/lib/notmuch.h b/lib/notmuch.h index e6e5cc2e..3633bedd 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -300,11 +300,22 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch); * (see notmuch_database_get_path), or else should be an absolute path * with initial components that match the path of 'database'. * - * Can return NULL if a Xapian exception occurs. + * If this directory object does not exist in the database, this + * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL. + * + * Return value: + * + * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory. + * + * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL. + * + * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; + * directory not retrieved. */ -notmuch_directory_t * +notmuch_status_t notmuch_database_get_directory (notmuch_database_t *database, - const char *path); + const char *path, + notmuch_directory_t **directory); /* Add a new message to the given notmuch database or associate an * additional filename with an existing message.