VaultPassword Property

The whole-vault encryption password.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetVaultPassword();
int SetVaultPassword(const char* lpszVaultPassword);

Unicode (Windows)
LPWSTR GetVaultPassword();
INT SetVaultPassword(LPCWSTR lpszVaultPassword);

@property (nonatomic,readwrite,assign,getter=vaultPassword,setter=setVaultPassword:) NSString* vaultPassword;
- (NSString*)vaultPassword;
- (void)setVaultPassword:(NSString*)newVaultPassword;

#define PID_CBVAULT_VAULTPASSWORD 23

CBFSSTORAGE_EXTERNAL void* CBFSSTORAGE_CALL CBFSStorage_CBVault_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CBFSSTORAGE_EXTERNAL int CBFSSTORAGE_CALL CBFSStorage_CBVault_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property specifies the whole-vault encryption password to use when creating new vaults and opening existing vaults.

To create a new vault with whole-vault encryption enabled, the VaultEncryption property must be set as well.

When an existing vault is opened, the class updates VaultEncryption automatically based on the detected whole-vault encryption mode. If the vault is encrypted, the class will attempt to access it using the password specified by VaultPassword. If VaultPassword is incorrect, the attempt will fail and the vault will not be opened.

The VaultEncryption and VaultPassword properties cannot be used to change an open vault's whole-vault encryption mode or password; use the UpdateVaultEncryption method.

Please refer to the Encryption topic for more information.

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

String