CBFS Filter 2020 C++ Builder Edition

Questions / Feedback?

CBProcess Component

Properties   Methods   Events   Configuration Settings   Errors  

The CBProcess component allows applications to intercept process manager requests.

Syntax

TcbfCBProcess

Remarks

The CBProcess component gives applications the ability to monitor and (for some cases) control process- and thread-related requests. The CBProcess API is far less complex than the other components', so it uses very simple filter rules; please refer to the Filter Rules topic for more information.

To learn more about the component's capabilities, please refer to the product's General Information topics.

Getting Started

  1. If the component's system driver hasn't been installed yet, call the Install method to do so. This only needs to be done once.
    • In production, the driver can be installed (or updated) ahead-of-time by the application's installation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
  2. Call the Initialize method to initialize the CBProcess component. This must be done each time the application starts.
  3. Add one or more filter rules using methods like AddFilteredProcessById, AddFilteredProcessByName, etc. (Rules can also be added/removed after the filter is started.)
  4. Call the StartFilter method to start filtering process manager requests.
  5. When finished, call the StopFilter method to stop filtering process manager requests.
  6. To uninstall the component's system driver, call the Uninstall method. This should not be done as part of the driver upgrade process.
    • In production, the driver can be uninstalled by the application's uninstallation script using the Installer DLL. Please refer to the Driver Installation topic for more information.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

ActiveWhether the component is active and processing requests.
AltitudeThe altitude the component's system driver should use.
SerializeEventsWhether events should be fired on a single worker thread, or many.
StrictAltitudeHow to behave if the specified altitude is already in use.
TagStores application-defined data specific to this instance of the component.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddFilteredProcessByIdAdds a process, by PID, to the list of filtered processes.
AddFilteredProcessByNameAdds a process, by name, to the list of filtered processes.
AddIgnoredProcessByIdAdds a process, by PID, to the list of ignored processes.
AddIgnoredProcessByNameAdds a process, by name, to the list of ignored processes.
ConfigSets or retrieves a configuration setting.
GetDriverStatusRetrieves the status of the component's system driver.
GetDriverVersionRetrieves the version of the component's system driver.
GetOriginatorTokenRetrieves the security token associated with the process that initiated the operation.
GetProcessNameRetrieves the name of the process associated with the specified process ID (PID).
InitializeInitializes the component.
InstallInstalls (or upgrades) the component's system driver.
RemoveFilteredProcessByIdRemoves a process, by PID, from the list of filtered processes.
RemoveFilteredProcessByNameRemoves a process, by name, from the list of filtered processes.
RemoveIgnoredProcessByIdRemoves a process, by PID, from the list of ignored processes.
RemoveIgnoredProcessByNameRemoves a process, by name, from the list of ignored processes.
ResetTimeoutResets the timeout duration for the current event handler.
ShutdownSystemShuts down or reboots the operating system.
StartFilterStart filtering process and thread operations.
StopFilterStop filtering process and thread operations.
UninstallUninstalls the component's system driver.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorFires if an unhandled error occurs during an event.
ProcessCreationFires when a process is being created.
ProcessHandleOperationFires when a process handle is being created or duplicated.
ProcessTerminationFires when a process is being terminated.
ThreadCreationFires when a thread is being created.
ThreadHandleOperationFires when a thread handle is being created or duplicated.
ThreadTerminationFires when a thread is being terminated.
WorkerThreadCreationFires just after a new worker thread is created.
WorkerThreadTerminationFires just before a worker thread is terminated.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

FilterOwnRequestsWhether the component's system driver should filter requests made by the application itself.
LoggingEnabledWhether extended logging is enabled.
MaxWorkerThreadCountThe maximum number of worker threads to use to fire events.
MinWorkerThreadCountThe minimum number of worker threads to use to fire events.
WorkerInitialStackSizeThe initial stack size to create worker threads with.
BuildInfoInformation about the product's build.
LicenseInfoInformation about the current license.

 
 
Copyright (c) 2020 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 C++ Builder Edition - Version 20.0 [Build 7543]