CBFS Filter 2020 Node.js Edition

Questions / Feedback?

AddIgnoredProcessById Method

Adds a process, by PID, to the list of ignored processes.

Syntax

cbregistry.addIgnoredProcessById(processId, includeChildren, [callback])

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 this 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 method adds the process with the specified ProcessId (PID) to the list of processes whose requests should be ignored (i.e., that the class should not fire events for).

This method is provided for compatibility with CBFS Registry 2017. It is recommended to use the new AddFilterRule, DeleteFilterRule, and related methods instead.

The ProcessId parameter specifies the PID of the process whose requests should be ignored. The value passed for this parameter must be the PID of an existing process. When adding a PID-based rule, you need to be aware of the PID Reuse behavior of Windows.

The IncludeChildren parameter specifies whether requests made by the specified process's children should also be ignored.

Note that the class's system driver ignores all processes' requests by default; applications should only use this method to explicitly exclude a process that would otherwise be filtered due to a process filtering rule added with AddFilteredProcessById or AddFilteredProcessByName.

Note: This method can only be called when Active is true.

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