HandleAllFsctls Property

Whether to fire the Fsctl event for all FSCTL_* requests.

Syntax

 cbfs.getHandleAllFsctls([callback])
 cbfs.setHandleAllFsctls( handleAllFsctls, [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 getHandleAllFsctls([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 setHandleAllFsctls([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 when the class should fire the Fsctl event. When disabled (default), the Fsctl event will only fire for FSCTLs whose function codes are in the 2400-4096 range (these codes are reserved by CBFS Connect for application use). When enabled, this Fsctl will fire for every FSCTL, except those processed by CBFS Connect itself.

Note: This property cannot be changed after a virtual drive is created, and cannot be changed within events.

This property is not available at design time.

Data Type

Boolean