FilterMode Property

The filter mode the class's system driver should use.

Syntax

 cbfilter.getFilterMode([callback])
 cbfilter.setFilterMode( filterMode, [callback])

Default Value

1

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 getFilterMode([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 setFilterMode([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's system driver should operate in minifilter or legacy mode; please refer to the Minifilter and Legacy Modes topic for more information. Possible values are:

Please note that:

• A driver altitude must be specified, via the Altitude property or the Install method, in order to successfully start the filter if this property is FS_FILTER_MODE_MINIFILTER (default).
• If this property's value is changed, the system must be rebooted in order for the change to go into effect.

Note: This property cannot be changed when Active is true. Additionally, the Initialize method must be called before attempting to get or set this property's value, which is stored in the registry.

This property is not available at design time.

Data Type

Integer