IsValidVault Method

Checks whether a local file is a CBFS Vault vault.

Syntax

ANSI (Cross Platform)
int IsValidVault();

Unicode (Windows)
INT IsValidVault();
- (BOOL)isValidVault;
#define MID_CBVAULT_ISVALIDVAULT 47

CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method checks whether the file specified by the VaultFile property is a CBFS Vault vault that can be opened by the class. The file being checked must be fully closed when this method is called.

If the specified file is a CBFS Vault vault, this method returns true; otherwise it returns false.

If the CallbackMode property is enabled, the check will be performed via the appropriate Vault* events (and the value held by VaultFile is simply passed to such events for the application to use).

Note that this method uses a simple detection mechanism; it doesn't perform a full consistency check or attempt any repairs, so applications may still need to call CheckAndRepair even if this method returns true. If an error occurs during the detection process, this method fails with an error.

Note: This method cannot be called when Active is true, and cannot be called within events.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 C++ Edition - Version 20.0 [Build 7986]