VaultState Property
Information about the state of the vault.
Syntax
cbdrive.getVaultState([callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getVaultState([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setVaultState([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property reflects the current state of the vault; its value consists of one or more of the following flags, OR'd together:
CBFSSTORAGE_ST_FIXED_SIZE | 0x00000001 | The vault is fixed-size. |
CBFSSTORAGE_ST_READ_ONLY | 0x00000002 | The vault was opened in read-only mode.
Please refer to the ReadOnly property for more information. |
CBFSSTORAGE_ST_CORRUPTED | 0x00000004 | The vault is corrupted.
Applications can use the CheckAndRepair method to try to repair vault corruption. Please refer to the Vault Corruption topic for more information. |
CBFSSTORAGE_ST_TRANSACTIONS_USED | 0x00000008 | The vault was opened in journaling mode.
Please refer to the UseJournaling property for more information. |
CBFSSTORAGE_ST_ACCESS_TIME_USED | 0x00000010 | Last access times are being tracked.
Please refer to the UseAccessTime property for more information. |
CBFSSTORAGE_ST_ENCRYPTED | 0x00000020 | The vault is encrypted with whole-vault encryption.
Please refer to the Encryption topic for more information. |
CBFSSTORAGE_ST_VALID_PASSWORD_SET | 0x00000040 | The correct whole-vault encryption password has been provided.
Please refer to the Encryption topic for more information. |
CBFSSTORAGE_ST_PHYSICAL_VOLUME | 0x00000080 | The vault is backed by a storage volume or partition formatted with the CBFS Storage filesystem.
This flag only applies when using the CBDrive class. |
CBFSSTORAGE_ST_PARTED | 0x00000100 | The vault's contents are split across multiple files on disk.
Please refer to the Multipart Vaults topic for more information. |
This property is read-only and not available at design time.
Data Type
Integer