CBFS Filter 2020 Python Edition

Questions / Feedback?

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

  1. 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.
  2. Call the initialize method to initialize the CBProcess class. This must be done each time the application starts.
  3. 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.)
  4. Call the start_filter method to start filtering process manager requests.
  5. When finished, call the stop_filter method to stop filtering process manager requests.
  6. 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.

activeWhether the class is active and processing requests.
altitudeThe altitude the class's system driver should use.
serialize_eventsWhether events should be fired on a single worker thread, or many.
strict_altitudeHow to behave if the specified altitude is already in use.
tagStores 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_idAdds a process, by PID, to the list of filtered processes.
add_filtered_process_by_nameAdds a process, by name, to the list of filtered processes.
add_ignored_process_by_idAdds a process, by PID, to the list of ignored processes.
add_ignored_process_by_nameAdds a process, by name, to the list of ignored processes.
configSets or retrieves a configuration setting.
get_driver_statusRetrieves the status of the class's system driver.
get_driver_versionRetrieves the version of the class's system driver.
get_originator_tokenRetrieves the security token associated with the process that initiated the operation.
get_process_nameRetrieves the name of the process associated with the specified process ID (PID).
initializeInitializes the class.
installInstalls (or upgrades) the class's system driver.
remove_filtered_process_by_idRemoves a process, by PID, from the list of filtered processes.
remove_filtered_process_by_nameRemoves a process, by name, from the list of filtered processes.
remove_ignored_process_by_idRemoves a process, by PID, from the list of ignored processes.
remove_ignored_process_by_nameRemoves a process, by name, from the list of ignored processes.
reset_timeoutResets the timeout duration for the current event handler.
shutdown_systemShuts down or reboots the operating system.
start_filterStart filtering process and thread operations.
stop_filterStop filtering process and thread operations.
uninstallUninstalls 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_errorFires if an unhandled error occurs during an event.
on_process_creationFires when a process is being created.
on_process_handle_operationFires when a process handle is being created or duplicated.
on_process_terminationFires when a process is being terminated.
on_thread_creationFires when a thread is being created.
on_thread_handle_operationFires when a thread handle is being created or duplicated.
on_thread_terminationFires when a thread is being terminated.
on_worker_thread_creationFires just after a new worker thread is created.
on_worker_thread_terminationFires 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.

FilterOwnRequestsWhether the class'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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 7917]