CBFS Storage 2020 Node.js Edition

Questions / Feedback?

DefaultFilePassword Property

The default encryption password to use when creating or opening files and alternate streams.

Syntax

 cbdrive.getDefaultFilePassword([callback])
 cbdrive.setDefaultFilePassword( defaultFilePassword, [callback])

Default Value

""

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 the getDefaultFilePassword([callback]) 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.

The callback for the setDefaultFilePassword([callback]) 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 property specifies the default encryption password that the class should use when creating or opening files and alternate streams.

Please refer to the Encryption topic for more information.

As an alternative to using this property, applications can call the CacheFilePassword method (before a file is opened) to specify a one-time-use password, or specify file encryption passwords dynamically using the FilePasswordNeeded event.

Data Type

String

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