CBFS Storage 2020 Node.js Edition

Questions / Feedback?

IsCBFSStorageVault Method

Checks whether a local file is a CBFS Storage vault.

Syntax

cbvault.isCBFSStorageVault([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method checks whether the file specified by the VaultFile property is a CBFS Storage 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 Storage 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 .

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

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Node.js Edition - Version 20.0 [Build 7922]