CheckFilePassword Method

Verifies whether a particular file password is correct.

Syntax

ANSI (Cross Platform)
int CheckFilePassword(const char* lpszFileName, const char* lpszPassword);

Unicode (Windows)
INT CheckFilePassword(LPCWSTR lpszFileName, LPCWSTR lpszPassword);
- (BOOL)checkFilePassword:(NSString*)fileName :(NSString*)password;
#define MID_CBVAULT_CHECKFILEPASSWORD 4

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

Remarks

This method verifies whether the specified Password matches the one used to encrypt the file or alternate stream specified by FileName. If the password is correct, this method returns true; otherwise it returns false.

The value passed for FileName must be a vault-local absolute path.

Please refer to the Encryption topic for more information.

Note: This method can only be called when Active is true.

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]