open_vault Method
Opens a new or existing vault.
Syntax
def open_vault(open_mode: int) -> None: ...
Remarks
This method opens a vault, creating it if necessary based on the specified OpenMode.
The OpenMode parameter specifies what behavior to use when opening a vault. Valid values are:
| CBFSSTORAGE_OM_CREATE_NEW | 0 | Creates a new vault if possible, failing if one already exists. |
| CBFSSTORAGE_OM_CREATE_ALWAYS | 1 | Creates a new vault, overwriting an existing one if necessary. |
| CBFSSTORAGE_OM_OPEN_EXISTING | 2 | Opens a vault if it exists; fails otherwise. |
| CBFSSTORAGE_OM_OPEN_ALWAYS | 3 | Opens a vault if it exists; creates a new one otherwise. |
When a vault is being created or opened, the vault_file and/or callback_mode properties are used to specify its location. If callback_mode is disabled (default), the class creates or opens a file-based vault at the path specified by vault_file.
If callback_mode is enabled, then the application itself controls where the vault is located and how it is accessed via the Vault* events (and the value held by vault_file is simply passed to said events for the application to use). For brevity, vaults created and accessed using callback mode are referred to as "callback mode vaults"; please refer to the Callback Mode topic for more information.
The class also has a number of other properties and configuration settings used when creating or opening a vault, all of which are listed below. Please refer to each one's documentation for more information, including usage restrictions.
- auto_compact_at property
- AutoCompactDelay configuration setting
- case_sensitive property
- logo property
- MaxNonPagedNameLength configuration setting
- page_size property
- PartSize configuration setting
- path_separator property
- read_only property
- use_access_time property
- use_journaling property
- use_system_cache property
If a file-based vault's storage file (or the storage device it is located on) is marked as read-only, then the read_only property must be enabled before this method is called. If an application attempts to open a vault with a read-only storage file in read-write mode, this method raises an exception.
Note: This method cannot be called when active is True, and cannot be called within events.