da_notmuch_database_get_directory

Retrieve a directory object from the database for 'path'.

Here, 'path' should be a path relative to the path of 'database' (see notmuch_database_get_path), or else should be an absolute path with initial components that match the path of 'database'.

If this directory object does not exist in the database, this returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.

Otherwise the returned directory object is owned by the database and as such, will only be valid until notmuch_database_destroy is called.

Return value:

alias da_notmuch_database_get_directory = notmuch_status_t function(
,
const(char)* path
,
notmuch_directory_t** directory
)

Detailed Description

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 STATUS UPGRADE REQUIRED

The caller must upgrade the database to use this function.

Meta