CloseVault Method

Closes the vault.

Syntax

ANSI (Cross Platform)
int CloseVault(int bForce);

Unicode (Windows)
INT CloseVault(BOOL bForce);
- (void)closeVault:(BOOL)force;
#define MID_CBDRIVE_CLOSEVAULT 9

CBFSSTORAGE_EXTERNAL int CBFSSTORAGE_CALL CBFSStorage_CBDrive_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method closes the currently-open vault.

For CBDrive, the Force parameter specifies whether to forcefully close any file or directory handles open currently. If Force is false, this method will fail if any handles are currently open. (In CBVault, the Force parameter's value is ignored.)

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

Error Handling (C++)

This method returns a 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. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

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