CBProcess Class
Properties Methods Events Configuration Settings Errors
The CBProcess class enables applications to intercept process manager requests.
Syntax
class cbfsfilter.CBProcess
Remarks
The CBProcess class 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 classs', so it uses very simple filter rules; please refer to the Filter Rules topic for more information.
To learn more about the class's capabilities, please refer to the product's General Information topics.
Getting Started
- If the class'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.
- Call the initialize method to initialize the CBProcess class. This must be done each time the application starts.
- Add one or more filter rules using methods like add_filtered_process_by_id, add_filtered_process_by_name, etc. (Rules can also be added/removed after the filter is started.)
- Call the start_filter method to start filtering process manager requests.
- When finished, call the stop_filter method to stop filtering process manager requests.
- To uninstall the class'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 class with short descriptions. Click on the links for further details.
| active | Whether the class is active and processing requests. |
| altitude | The altitude the class's system driver should use. |
| serialize_events | Whether events should be fired on a single worker thread, or many. |
| strict_altitude | How to behave if the specified altitude is already in use. |
| tag | Stores application-defined data specific to this instance of the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_filtered_process_by_id | Adds a process, by PID, to the list of filtered processes. |
| add_filtered_process_by_name | Adds a process, by name, to the list of filtered processes. |
| add_ignored_process_by_id | Adds a process, by PID, to the list of ignored processes. |
| add_ignored_process_by_name | Adds a process, by name, to the list of ignored processes. |
| config | Sets or retrieves a configuration setting. |
| get_driver_status | Retrieves the status of the class's system driver. |
| get_driver_version | Retrieves the version of the class's system driver. |
| get_originator_token | Retrieves the security token associated with the process that initiated the operation. |
| get_process_name | Retrieves the name of the process associated with the specified process ID (PID). |
| initialize | Initializes the class. |
| install | Installs (or upgrades) the class's system driver. |
| remove_filtered_process_by_id | Removes a process, by PID, from the list of filtered processes. |
| remove_filtered_process_by_name | Removes a process, by name, from the list of filtered processes. |
| remove_ignored_process_by_id | Removes a process, by PID, from the list of ignored processes. |
| remove_ignored_process_by_name | Removes a process, by name, from the list of ignored processes. |
| reset_timeout | Resets the timeout duration for the current event handler. |
| shutdown_system | Shuts down or reboots the operating system. |
| start_filter | Start filtering process and thread operations. |
| stop_filter | Stop filtering process and thread operations. |
| uninstall | Uninstalls the class's system driver. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Fires if an unhandled error occurs during an event. |
| on_process_creation | Fires when a process is being created. |
| on_process_handle_operation | Fires when a process handle is being created or duplicated. |
| on_process_termination | Fires when a process is being terminated. |
| on_thread_creation | Fires when a thread is being created. |
| on_thread_handle_operation | Fires when a thread handle is being created or duplicated. |
| on_thread_termination | Fires when a thread is being terminated. |
| on_worker_thread_creation | Fires just after a new worker thread is created. |
| on_worker_thread_termination | Fires just before a worker thread is terminated. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| FilterOwnRequests | Whether the class's system driver should filter requests made by the application itself. |
| LoggingEnabled | Whether extended logging is enabled. |
| MaxWorkerThreadCount | The maximum number of worker threads to use to fire events. |
| MinWorkerThreadCount | The minimum number of worker threads to use to fire events. |
| WorkerInitialStackSize | The initial stack size to create worker threads with. |
| BuildInfo | Information about the product's build. |
| LicenseInfo | Information about the current license. |