Function notmuch_sys::notmuch_database_find_message [−] [src]

pub unsafe extern "C" fn notmuch_database_find_message(
    database: *mut notmuch_database_t, 
    message_id: *const c_char, 
    message: *mut *mut notmuch_message_t
) -> notmuch_status_t

Find a message with the given message_id.

If a message with the given message_id is found then, on successful return (notmuch_status_t::SUCCESS) '*message' will be initialized to a message object. The caller should call notmuch_message_destroy when done with the message.

On any failure or when the message is not found, this function initializes '*message' to NULL. This means, when notmuch_status_t::SUCCESS is returned, the caller is supposed to check '*message' for NULL to find out whether the message with the given message_id was found.

Return value:

  • notmuch_status_t::SUCCESS: Successful return, check '*message'.

  • notmuch_status_t::NULL_POINTER: The given 'message' argument is NULL

  • notmuch_status_t::OUT_OF_MEMORY: Out of memory, creating message object

  • notmuch_status_t::XAPIAN_EXCEPTION: A Xapian exception occurred