CBFS Filter 2020 Node.js Edition

Questions / Feedback?

DefaultRuleMask Property

A file mask that determines which files and directories match the rule.

Syntax

 cbfilter.getDefaultRuleMask(index, [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 getDefaultRuleMask([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 setDefaultRuleMask([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

A file mask that determines which files and directories match the rule.

This property reflects the file mask used to determine whether a file or directory matches the rule. In addition to being its primary match qualifier, a rule's mask also serves as its identifier; every rule in a ruleset must have a unique mask.

Note that when a rule with a drive letter is added, said drive letter is automatically converted to NT Device format, so this property's value will contain the NT Device name. To determine a drive's drive letter, use the GetVolumeGUID method to obtain its volume GUID, then enumerate its mounting points (which will include any drive letter(s) associated with it).

The index parameter specifies the index of the item in the array. The size of the array is controlled by the DefaultRuleCount property.

This property is read-only and not available at design time.

Data Type

String

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