NOTMUCH_STATUS_SUCCESS

Status codes used for the return values of most functions.

A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function completed without error. Any other value indicates an error.

Values

ValueMeaning
NOTMUCH_STATUS_SUCCESS0

No error occurred.

NOTMUCH_STATUS_OUT_OF_MEMORY

Out of memory.

NOTMUCH_STATUS_READ_ONLY_DATABASE

An attempt was made to write to a database opened in read-only mode.

NOTMUCH_STATUS_XAPIAN_EXCEPTION

A Xapian exception occurred.

@todo We don't really want to expose this lame XAPIAN_EXCEPTION value. Instead we should map to things like DATABASE_LOCKED or whatever.

NOTMUCH_STATUS_FILE_ERROR

An error occurred trying to read or write to a file (this could be file not found, permission denied, etc.)

NOTMUCH_STATUS_FILE_NOT_EMAIL

A file was presented that doesn't appear to be an email message.

NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID

A file contains a message ID that is identical to a message already in the database.

NOTMUCH_STATUS_NULL_POINTER

The user erroneously passed a NULL pointer to a notmuch function.

NOTMUCH_STATUS_TAG_TOO_LONG

A tag value is too long (exceeds NOTMUCH_TAG_MAX).

NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW

The notmuch_message_thaw function has been called more times than notmuch_message_freeze.

NOTMUCH_STATUS_UNBALANCED_ATOMIC

notmuch_database_end_atomic has been called more times than notmuch_database_begin_atomic.

NOTMUCH_STATUS_UNSUPPORTED_OPERATION

The operation is not supported.

NOTMUCH_STATUS_UPGRADE_REQUIRED

The operation requires a database upgrade.

NOTMUCH_STATUS_PATH_ERROR

There is a problem with the proposed path, e.g. a relative path passed to a function expecting an absolute path.

NOTMUCH_STATUS_ILLEGAL_ARGUMENT

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

NOTMUCH_STATUS_LAST_STATUS

Not an actual status value. Just a way to find out how many valid status values there are.

Meta