CBFS Storage 2020 Node.js Edition

Questions / Feedback?

CopyFromVault Method

Copies files and directories from the vault to a physical filesystem.

Syntax

cbvault.copyFromVault(vaultPath, systemPath, mask, flags, password, [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){ }

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

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method copies the files and directories at the specified VaultPath to a physical filesystem location, specified by SystemPath. Only the files and directories whose names match the specified Mask are copied.

The values passed for VaultPath and SystemPath must be vault-local and system-local absolute paths, respectively. The value passed for Mask may contain wildcard characters.

The Flags parameter is used to control recursion and overwrite behavior, and should be set by OR'ing together zero or more of the following flags:

CBFSSTORAGE_CFF_OVERWRITE_NONE0x00000000Never overwrite destination files.

CBFSSTORAGE_CFF_OVERWRITE_IF_NEWER0x00000001Overwrite a destination file only if the source file is newer.

CBFSSTORAGE_CFF_OVERWRITE_ALL0x00000002Always overwrite destination files.

CBFSSTORAGE_CFF_INCLUDE_SUBDIRS_WITH_CONTENTS0x00010000Include all subdirectories in source directory, and their contents, recursively.

CBFSSTORAGE_CFF_INCLUDE_SUBDIRS_NO_CONTENTS0x00020000Include all subdirectories in the source directory, without their contents.

The Password parameter specifies the password to use to access files' data, if they are encrypted.

Note: This method can only 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]