CBFS Storage 2020 Node.js Edition

Questions / Feedback?

ReadOnly Property

Whether the class should open a vault in read-only mode.

Syntax

 cbvault.getReadOnly([callback])
 cbvault.setReadOnly( readOnly, [callback])

Default Value

FALSE

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 getReadOnly([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 setReadOnly([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 whether the class should open a vault in read-only mode. When a vault is open in read-only mode, the following restrictions apply:

  • No new vault items (files, directories, symbolic links, and alternate streams) may be created.
  • No existing vault items may be modified, renamed, moved, or deleted. (This includes updating access times.)
  • The vault cannot be resized or compacted (automatically or explicitly).
  • Vault corruption cannot be repaired using CheckAndRepair.
(Note that this list may not necessarily be exhaustive.)

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Boolean

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