X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=9a2a3b1f242420802bc8cbb9d31a372df5594b4d;hb=f4f5db0f1a6e89f56bfd73f8517c1cac7af20290;hp=d9f3003fad32381151d92ea9d847d695daf65a77;hpb=ab456541924dcb1e1c6d6c7ba1781011e3453f27;p=notmuch diff --git a/lib/notmuch.h b/lib/notmuch.h index d9f3003f..9a2a3b1f 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -447,6 +447,8 @@ notmuch_database_get_version (notmuch_database_t *database); * FALSE for a read-only database because there's no way to upgrade a * read-only database. * + * Also returns FALSE if an error occurs accessing the database. + * */ notmuch_bool_t notmuch_database_needs_upgrade (notmuch_database_t *database); @@ -2146,6 +2148,8 @@ notmuch_directory_get_mtime (notmuch_directory_t *directory); * * The returned filenames will be the basename-entries only (not * complete paths). + * + * Returns NULL if it triggers a Xapian exception */ notmuch_filenames_t * notmuch_directory_get_child_files (notmuch_directory_t *directory); @@ -2156,6 +2160,8 @@ notmuch_directory_get_child_files (notmuch_directory_t *directory); * * The returned filenames will be the basename-entries only (not * complete paths). + * + * Returns NULL if it triggers a Xapian exception */ notmuch_filenames_t * notmuch_directory_get_child_directories (notmuch_directory_t *directory); @@ -2318,6 +2324,7 @@ notmuch_config_list_destroy (notmuch_config_list_t *config_list); * added to the index. At the moment it is a featureless stub. * * @since libnotmuch 5.1 (notmuch 0.26) + * @retval NULL in case of error */ notmuch_indexopts_t * notmuch_database_get_default_indexopts (notmuch_database_t *db);