X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=aaf92470fb67154313182ca76843f9fcfb6afba9;hb=31dab9b1cd66c7f285fe86021f66940f679325d4;hp=0dd442d46571e0b5d19e01e0c779f72811d1e7da;hpb=765ca7bc08f83a3c0f9ebffe58dab03634e45f37;p=notmuch diff --git a/lib/notmuch.h b/lib/notmuch.h index 0dd442d4..aaf92470 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -431,6 +431,8 @@ notmuch_database_get_path (notmuch_database_t *database); /** * Return the database format version of the given database. + * + * @retval 0 on error */ unsigned int notmuch_database_get_version (notmuch_database_t *database); @@ -444,6 +446,9 @@ notmuch_database_get_version (notmuch_database_t *database); * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns * 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); @@ -2315,6 +2320,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);