VaultFile Property

The vault to create and/or open.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetVaultFile();
int SetVaultFile(const char* lpszVaultFile);

Unicode (Windows)
LPWSTR GetVaultFile();
INT SetVaultFile(LPCWSTR lpszVaultFile);

@property (nonatomic,readwrite,assign,getter=vaultFile,setter=setVaultFile:) NSString* vaultFile;
- (NSString*)vaultFile;
- (void)setVaultFile:(NSString*)newVaultFile;

#define PID_CBVAULT_VAULTFILE 21

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 vault to create and/or open when the OpenVault method is called.

When the CallbackMode property is disabled (default), this property specifies the vault storage file to create/open, and must be set to a fully-qualified file path formatted according to OS conventions.

When the CallbackMode property is enabled, this property is only used to populate the Vault parameter of the VaultOpen, VaultGetParentSize, and VaultDelete events; and can be set to any application-defined value. Please refer to the Callback Mode topic for more information.

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

Data Type

String