CBRegistry Class

Properties   Methods   Events   Config Settings   Errors  

The CBRegistry class allows applications to intercept and control registry requests.

Syntax

class cbfsfilter.CBRegistry

Remarks

The CBRegistry class gives applications the ability to intercept and registry requests, allowing them to be altered, handled, and blocked. Applications use standard filter rules to specify which requests they are interested in intercepting; and special filter rules to enforce access restrictions.

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 has not been installed yet, call the install method to do so. This needs to be done only 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 CBRegistry class. This must be done each time the application starts.
3. Add one or more filter rules using methods like add_filter_rule. (Rules also can be added or removed after the filter is started.)
4. Call the start_filter method to start filtering filesystem requests.
5. When finished, call the stop_filter method to stop filtering filesystem 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.

Method List

---

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

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.

Config Settings

---

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

active Property

This property notes whether the class is active and processing requests.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

Default Value

FALSE

Remarks

This property reflects whether the class is active and currently processing requests. It will be True after the filter has been attached successfully via a call to start_filter.

This property is read-only.

altitude Property

This property specifies the altitude the class's system driver should use.

Syntax

def get_altitude() -> str: ...
def set_altitude(value: str) -> None: ...

altitude = property(get_altitude, set_altitude)

Default Value

"400055"

Remarks

This property specifies the altitude that the class's system driver should use. A driver's altitude determines its absolute position in the stack of filter drivers; drivers with higher altitudes are attached toward the top of the stack, closer to the user mode, which allows them to process requests earlier.

Registry filter drivers are not required to specify an altitude; and this property's default empty value is interpreted as "no altitude". However, registry filter drivers that do not specify an altitude will always be attached near the top of the filter driver stack, which may not be desirable. Please refer to the Driver Altitudes topic for more information.

default_rule_count Property

The number of records in the DefaultRule arrays.

Syntax

def get_default_rule_count() -> int: ...

default_rule_count = property(get_default_rule_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• default_rule_access_flags
• default_rule_mask

The array indices start at 0 and end at default_rule_count - 1.

This property is read-only.

default_rule_access_flags Property

This property indicates the access restrictions enforced by the rule.

Syntax

def get_default_rule_access_flags(default_rule_index: int) -> int: ...

Default Value

0

Remarks

This property indicates the access restrictions enforced by the rule.

This property indicates which access restrictions are enforced by the rule. Please refer to the Default Rules topic for more information. The value of this property is a combination of zero or more of the following:

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

This property is read-only.

default_rule_mask Property

This property reflects a registry key mask that determines which registry keys match the rule.

Syntax

def get_default_rule_mask(default_rule_index: int) -> str: ...

Default Value

""

Remarks

This property reflects a registry key mask that determines which registry keys match the rule.

This property reflects the registry key mask used to determine whether a registry key 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.

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

This property is read-only.

filter_rule_count Property

The number of records in the FilterRule arrays.

Syntax

def get_filter_rule_count() -> int: ...

filter_rule_count = property(get_filter_rule_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• filter_rule_access_flags
• filter_rule_control_flags
• filter_rule_mask

The array indices start at 0 and end at filter_rule_count - 1.

This property is read-only.

filter_rule_access_flags Property

This property indicates the access restrictions enforced by the rule.

Syntax

def get_filter_rule_access_flags(filter_rule_index: int) -> int: ...

Default Value

0

Remarks

This property indicates the access restrictions enforced by the rule.

This property indicates which access restrictions are enforced by the rule. Please refer to the Access Rules topic for more information. The value of this property is a combination of zero or more of the following:

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

This property is read-only.

filter_rule_control_flags Property

This property indicates which control events the rule causes the class to fire.

Syntax

def get_filter_rule_control_flags(filter_rule_index: int) -> int: ...

Default Value

0

Remarks

This property indicates which control events the rule causes the class to fire.

This property indicates which registry operations, of those performed on matching registry keys, the class should fire Control Events for. The value of this property is a combination of zero or more of the following:

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

This property is read-only.

filter_rule_mask Property

This property reflects a registry key mask that determines which registry keys match the rule.

Syntax

def get_filter_rule_mask(filter_rule_index: int) -> str: ...

Default Value

""

Remarks

This property reflects a registry key mask that determines which registry keys match the rule.

This property reflects the registry key mask used to determine whether a registry key 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.

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

This property is read-only.

passthrough_rule_count Property

The number of records in the PassthroughRule arrays.

Syntax

def get_passthrough_rule_count() -> int: ...

passthrough_rule_count = property(get_passthrough_rule_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• passthrough_rule_access_flags
• passthrough_rule_control_flags
• passthrough_rule_mask

The array indices start at 0 and end at passthrough_rule_count - 1.

This property is read-only.

passthrough_rule_access_flags Property

This property indicates the access restrictions lifted by the rule.

Syntax

def get_passthrough_rule_access_flags(passthrough_rule_index: int) -> int: ...

Default Value

0

Remarks

This property indicates the access restrictions lifted by the rule.

This property indicates which access restrictions are lifted by the rule. Please refer to the Passthrough Rules topic for more information. The value of this property is a combination of zero or more of the following:

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

This property is read-only.

passthrough_rule_control_flags Property

This property indicates which control events the rule prevents the class from firing.

Syntax

def get_passthrough_rule_control_flags(passthrough_rule_index: int) -> int: ...

Default Value

0

Remarks

This property indicates which control events the rule prevents the class from firing.

This property indicates which registry operations, of those performed on matching registry keys, the class should not fire Control Events for. Please refer to the Passthrough Rules topic for more information. The value of this property is a combination of zero or more of the following:

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

This property is read-only.

passthrough_rule_mask Property

This property reflects a registry key mask that determines which registry keys match the rule.

Syntax

def get_passthrough_rule_mask(passthrough_rule_index: int) -> str: ...

Default Value

""

Remarks

This property reflects a registry key mask that determines which registry keys match the rule.

This property reflects the registry key mask used to determine whether a registry key 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.

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

This property is read-only.

serialize_events Property

Whether events should be fired on a single worker thread, or many.

Syntax

def get_serialize_events() -> int: ...
def set_serialize_events(value: int) -> None: ...

serialize_events = property(get_serialize_events, set_serialize_events)

Default Value

0

Remarks

This property specifies whether the class should fire all events serially on a single worker thread, or concurrently on multiple worker threads. The possible values are:

Please refer to the Threading and Concurrency topic for more information.

Note: This property cannot be changed when active is True, and it cannot be changed within events.

tag Property

This property stores application-defined data specific to a particular instance of the class.

Syntax

def get_tag() -> int: ...
def set_tag(value: int) -> None: ...

tag = property(get_tag, set_tag)

Default Value

0

Remarks

This property can be used to store data specific to a particular instance of the class.

add_default_rule Method

This method adds a default rule.

Syntax

def add_default_rule(mask: str, access_flags: int, product_guid: str) -> bool: ...

Remarks

This method adds a default rule for the registry keys that matches the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Default rules, like access rules, instruct the class's system driver to apply certain access restrictions to matching registry keys. However, unlike access rules, default rules are managed by the driver directly; they are activated as soon as the driver loads at boot time, and then continue to be enforced at all times, regardless of whether or not the application that added them is open.

The Mask parameter must be a valid registry key mask according to the Registry Key Masks topic. Only the registry keys that match the specified mask will be covered by the rule.

The AccessFlags parameter specifies which access restrictions the class's system driver should apply to matching registry keys. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

The ProductGUID parameter identifies the application that the rule should be associated with in the registry. In most cases, the value passed for this parameter should be the same one that was used to call the initialize method.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error. Please refer to the Default Rules topic for more information.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

add_filtered_process_by_id Method

This method adds a process, by process ID (PID), to the list of filtered processes.

Syntax

def add_filtered_process_by_id(process_id: int, include_children: bool) -> None: ...

Remarks

This method adds the process with the specified ProcessId (PID) to the list of processes whose requests should be filtered (i.e., that the class should fire events for).

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The ProcessId parameter specifies the PID of the process whose requests should be filtered. The value passed for this parameter must either be the PID of an existing process; or -1, which means "all processes". 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 filtered.

Note: This method can be called only when active is True.

add_filtered_process_by_name Method

This method adds a process, by name, to the list of filtered processes.

Syntax

def add_filtered_process_by_name(process_name: str, include_children: bool) -> None: ...

Remarks

This method adds the process with the specified ProcessName to the list of processes whose requests should be filtered (i.e., that the class should fire events for).

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The ProcessName parameter must be a valid process executable name. It may optionally begin with a path, and both the name and the path (if present) may include wildcards (* and ?). A process with a matching executable name does not actually need to exist when this method is called.

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

Note: This method can be called only when active is True.

add_filter_rule Method

This method adds a standard filter rule or access rule.

Syntax

def add_filter_rule(mask: str, access_flags: int, control_flags: int) -> bool: ...

Remarks

This method adds a standard filter rule or access rule for the registry keys that matches the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it. If the rule is added successfully, this method returns True; otherwise, it returns False.

Standard filter rules determine which registry operations, of those performed on matching registry keys, the class should fire its events for. Access rules instruct the class's system driver to apply certain access restrictions to matching registry keys.

The Mask parameter must be a valid registry key mask according to the Registry Key Masks topic. Only the registry keys that match the specified mask will be covered by the rule.

The AccessFlags parameter specifies which access restrictions the class's system driver should apply to matching registry keys. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

The ControlFlags parameter specifies which registry operations the class should fire Control Events for. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

add_ignored_process_by_id Method

This method adds a process, by process Id (PID), to the list of ignored processes.

Syntax

def add_ignored_process_by_id(process_id: int, include_children: bool) -> None: ...

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. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended 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: The class's system driver ignores all processes' requests by default; applications should use this method only to explicitly exclude a process that would otherwise be filtered because of a process filtering rule added with add_filtered_process_by_id or add_filtered_process_by_name.

Note: This method can be called only when active is True.

add_ignored_process_by_name Method

This method adds a process, by name, to the list of ignored processes.

Syntax

def add_ignored_process_by_name(process_name: str, include_children: bool) -> None: ...

Remarks

This method adds the process with the specified ProcessName 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. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The ProcessName parameter must be a valid process executable name. It may optionally begin with a path, and both the name and the path (if present) may include wildcards (* and ?). A process with a matching executable name does not actually need to exist when this method is called.

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

Note: The class's system driver ignores all processes' requests by default; applications should use this method only to explicitly exclude a process that would otherwise be filtered because of a process filtering rule added with add_filtered_process_by_id or add_filtered_process_by_name.

Note: This method can be called only when active is True.

add_passthrough_rule Method

This method adds a passthrough rule.

Syntax

def add_passthrough_rule(mask: str, access_flags: int, control_flags: int) -> bool: ...

Remarks

This method adds a passthrough rule for the registry keys that matches the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Passthrough rules exclude matching registry keys from being processed by other filter rules.

The Mask parameter must be a valid registry key mask according to the Registry Key Masks topic. Only the registry keys that match the specified mask will be covered by the rule.

The AccessFlags parameter specifies which access restrictions the class's system driver should lift from matching registry keys. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

The ControlFlags parameter specifies which registry operations the class should not fire Control Events for. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

close_default_rules_snapshot Method

This method closes the previously created default rules snapshot.

Syntax

def close_default_rules_snapshot() -> None: ...

Remarks

This method closes the default rules snapshot previously created by create_default_rules_snapshot, releasing the memory associated with it. Please refer to that method's documentation for more information.

Note: This method cannot be called within events.

The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads (e.g., during the on_after_filter_attach_to_volume and on_after_filter_detach_from_volume events) are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists both occur in a thread-safe manner.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_default_rules_snapshot Method

This method creates a snapshot of information about the default rules that have been added.

Syntax

def create_default_rules_snapshot(product_guid: str) -> None: ...

Remarks

This method creates a snapshot of information about all default rules that have been added by the application identified by ProductGUID. This information is then used to populate the DefaultRule* properties.

When the application is finished working with the default rules snapshot, it must close it by calling the close_default_rules_snapshot method to release the associated memory. If this method is called again before an existing snapshot is closed, the class will attempt to close it before creating a new one.

Note: This method cannot be called within events.

The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads (e.g., during the on_after_filter_attach_to_volume and on_after_filter_detach_from_volume events) are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists both occur in a thread-safe manner.

delete_all_filter_rules Method

This method deletes all standard filter rules.

Syntax

def delete_all_filter_rules() -> bool: ...

Remarks

This method deletes all standard filter rules that are currently present.

If the rules are deleted successfully, this method returns True; otherwise, it returns False.

To delete standard filter rules individually, use the delete_filter_rule method instead.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

delete_all_passthrough_rules Method

This method deletes all passthrough rules.

Syntax

def delete_all_passthrough_rules() -> bool: ...

Remarks

This method deletes all passthrough rules that are currently present.

If the rules are deleted successfully, this method returns True; otherwise, it returns False.

To delete passthrough rules individually, use the delete_passthrough_rule method instead.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

delete_default_rule Method

This method deletes a particular default rule.

Syntax

def delete_default_rule(mask: str, access_flags: int, product_guid: str) -> bool: ...

Remarks

This method deletes the specified AccessFlags from the default rule identified by Mask and associated with the application identified by ProductGUID. If AccessFlags includes all flags currently present in the rule, then the entire rule is deleted; otherwise, the flags specified by AccessFlags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the registry key mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.

The AccessFlags parameter specifies which access restrictions should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method. Please refer to the add_default_rule method's documentation for more information.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error. Please refer to the Default Rules topic for more information.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

delete_filter_rule Method

This method deletes a particular standard filter rule or access rule.

Syntax

def delete_filter_rule(mask: str, access_flags: int, control_flags: int) -> bool: ...

Remarks

This method deletes the specified AccessFlags or ControlFlags from the standard filter rule or access rule identified by Mask. If the aforementioned parameters include all flags currently present in the rule, then the entire rule is deleted; otherwise, the specified flags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the registry key mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.

The AccessFlags parameter specifies which access restrictions should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

The ControlFlags parameter specifies which Control Event flags should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

To delete all standard filter rules and access rules, use the delete_all_filter_rules method instead.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

delete_passthrough_rule Method

This method deletes a particular passthrough rule.

Syntax

def delete_passthrough_rule(mask: str, access_flags: int, control_flags: int) -> bool: ...

Remarks

This method deletes the specified AccessFlags or ControlFlags from the passthrough rule identified by Mask. If the aforementioned parameters include all flags currently present in the rule, then the entire rule is deleted; otherwise, the specified flags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the registry key mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.

The AccessFlags parameter specifies which access restrictions should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

The ControlFlags parameter specifies which Control Event flags should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:

To delete all passthrough rules, use the delete_all_passthrough_rules method instead.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists occurs in a thread-safe manner.

get_driver_status Method

This method retrieves the status of the class's system driver.

Syntax

def get_driver_status(product_guid: str) -> int: ...

Remarks

This method retrieves the status of the class's system driver. This status can then be used to verify whether it has been properly installed and is ready for use.

The value returned by the method corresponds to the dwCurrentState field of the SERVICE_STATUS structure from the Windows API. It will be one of the following:

ProductGUID is used to distinguish among driver installations performed by different applications. Such information is necessary to guard against unexpected situations, such as the driver being uninstalled by one application despite other applications still needing it.

Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_driver_version
• initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

get_driver_version Method

This method retrieves the version of the class's system driver.

Syntax

def get_driver_version(product_guid: str) -> int: ...

Remarks

This method retrieves the version of the class's system driver. The value is returned as a 64-bit integer composed of four 16-bit words that each correspond to a piece of the overall module version. For example, a version of 2.32.6.28 would cause the value 0x000200200006001C to be returned.

If the class's system driver is not installed, this method returns 0.

ProductGUID is used to distinguish among driver installations performed by different applications. Such information is necessary to guard against unexpected situations, such as the driver being uninstalled by one application despite other applications still needing it.

Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_driver_version
• initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

get_originator_process_id Method

This method retrieves the process Id (PID) that initiated the operation.

Syntax

def get_originator_process_id() -> int: ...

Remarks

This method can be called within events fired for registry operations to retrieve the process Id (PID) that initiated the operation. If the query fails, this method returns 0.

Note: PIDs are not unique and may be reused by different processes over time (although in practice, this is uncommon).

Note: This method can be called only within events.

get_originator_process_name Method

This method retrieves the name of the process that initiated the operation.

Syntax

def get_originator_process_name() -> str: ...

Remarks

This method can be called within events fired for registry operations to retrieve the name of the process that initiated the operation. If the query fails, this method returns empty string.

Note: This method can be called only within events.

get_originator_thread_id Method

This method retrieves the thread Id that initiated the operation.

Syntax

def get_originator_thread_id() -> int: ...

Remarks

This method can be called within events fired for registry operations to retrieve the thread Id that initiated the operation. If the query fails, this method returns 0.

Note: Thread Ids are not unique and may be reused by different threads over time.

Note: This method can be called only within events.

get_originator_token Method

This method retrieves the security token associated with the process that initiated the operation.

Syntax

def get_originator_token() -> int: ...

Remarks

This method can be called within events fired for registry operations to retrieve the security token associated with the process that initiated the operation. If the query fails, this method returns INVALID_HANDLE_VALUE.

The security token returned by this method can be passed to the Windows API's GetTokenInformation function to obtain more information about the process.

Note: When applications are finished using the returned security token, they must close it using the Windows API's CloseHandle function.

Note: This method can be called only within events.

initialize Method

This method initializes the class.

Syntax

def initialize(product_guid: str) -> None: ...

Remarks

This method initializes the class and must be called each time the application starts before attempting to call any of the class's other methods with the exception of installation-related methods.

ProductGUID is used to distinguish among driver installations performed by different applications. Such information is necessary to guard against unexpected situations, such as the driver being uninstalled by one application despite other applications still needing it.

Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_driver_version
• initialize

If the required driver was not installed using the install method with the same value of ProductGUID, initialize will return a ERROR_FILE_NOT_FOUND error (Win32 error code 2).

If the loaded kernel-mode driver is older than the user-mode API, initialize will return a ERROR_INVALID_KERNEL_INFO_VERSION error (Win32 error code 340). In this situation, an update of the driver using the install method is required before the class can be used.

install Method

This method installs (or upgrades) the class's system driver.

Syntax

def install(cab_file_name: str, product_guid: str, path_to_install: str, flags: int) -> bool: ...

Remarks

This method is used to install or upgrade the class's system driver. If the system must be rebooted to complete the installation process, this method returns True; otherwise, it returns False.

Important: To upgrade the class's driver, use only the install method. Previously installed versions of the driver should not be uninstalled first. Calling the install method will upgrade the previously installed version.

Please refer to the Driver Installation topic for more information.

CabFileName must be the path of the .cab file containing the class's system driver.

Note: This .cab file must remain on the target system (or be available in some other way) after installation, because it is required to uninstall the driver from the system.

ProductGUID is used to distinguish among driver installations performed by different applications. Such information is necessary to guard against unexpected situations, such as the driver being uninstalled by one application despite other applications still needing it.

Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• install
• uninstall
• get_driver_status
• get_driver_version
• initialize

PathToInstall controls where the driver is installed. Pass empty string (highly recommended) to automatically install the driver to the appropriate Windows system directory.

Flags specifies various installation options and should contain zero or more of the following flags, ORed together:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error.

Note: This method cannot be called within events.

remove_filtered_process_by_id Method

This method removes a process, by process Id (PID), from the list of filtered processes.

Syntax

def remove_filtered_process_by_id(process_id: int) -> None: ...

Remarks

This method removes the process with the specified ProcessId (PID) from the list of processes whose requests should be filtered.

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The value passed for ProcessId must be one that was previously used to call add_filtered_process_by_id; please refer to its documentation for more information.

Note: This method can be called only when active is True.

remove_filtered_process_by_name Method

This method removes a process, by name, from the list of filtered processes.

Syntax

def remove_filtered_process_by_name(process_name: str) -> None: ...

Remarks

This method removes the process with the specified ProcessName from the list of processes whose requests should be filtered.

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The value passed for ProcessName must be one that was previously used to call add_filtered_process_by_name; please refer to its documentation for more information.

Note: This method can be called only when active is True.

remove_ignored_process_by_id Method

This method removes a process, by process Id (PID), from the list of ignored processes.

Syntax

def remove_ignored_process_by_id(process_id: int) -> None: ...

Remarks

This method removes the process with the specified ProcessId (PID) from the list of processes whose requests should be ignored.

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The value passed for ProcessId must be one that was previously used to call add_ignored_process_by_id; please refer to its documentation for more information.

Note: This method can be called only when active is True.

remove_ignored_process_by_name Method

This method removes a process, by name, from the list of ignored processes.

Syntax

def remove_ignored_process_by_name(process_name: str) -> None: ...

Remarks

This method removes the process with the specified ProcessName from the list of processes whose requests should be ignored.

This method is provided for compatibility with CBFS Registry 2017. Use of the new add_filter_rule, delete_filter_rule, and related methods is recommended instead.

The value passed for ProcessName must be one that was previously used to call add_ignored_process_by_name; please refer to its documentation for more information.

Note: This method can be called only when active is True.

reset_timeout Method

This method resets the timeout duration for the current event handler.

Syntax

def reset_timeout(timeout: int) -> bool: ...

Remarks

When event timeouts are being enforced, this method can be called within an event handler to inform the class that request processing is taking longer than expected.

If called successfully, this method returns True, and the current event handler's timeout timer is immediately reset to 0; when it reaches the number of milliseconds specified by Timeout, the driver will either "release" the underlying request and pass it onwards, or cancel it by reporting an error; whichever is most appropriate for the event in question. Please refer to the Timeouts topic for more information.

Passing 0 for Timeout disables the timeout timer for the current event handler, allowing it to take as long as it needs to complete.

Note: This method can be called only within events.

shutdown_system Method

Shuts down or reboots the operating system.

Syntax

def shutdown_system(shutdown_prompt: str, timeout: int, force_close_apps: bool, reboot: bool) -> bool: ...

Remarks

This method shuts down or (if Reboot is True) reboots the operating system. If the appropriate privileges cannot be obtained, or if the InitiateSystemShutdown system call returns False, then this method will return False; otherwise, it returns True. This method can be used if the installation or uninstallation function requires the system to be rebooted in order to complete.

ShutdownPrompt, if non-empty, specifies a message that the OS should display to the user for Timeout seconds. If empty string is passed for ShutdownPrompt, no message is displayed and the Timeout parameter's value is ignored.

ForceCloseApps specifies whether the OS should forcefully close all applications. Please keep in mind that forceful closing of applications with unsaved data can lead to data loss.

Reboot specifies whether the OS should reboot (True) or just shut down (False).

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

start_filter Method

This method starts filtering registry operations.

Syntax

def start_filter(timeout: int) -> None: ...

Remarks

This method attaches the filter, causing the class's driver to start filtering registry operations according to the filter rules currently present. Rules can be added and removed both before and after this method is called, so long as the initialize method is called before doing anything else.

The Timeout parameter specifies how many milliseconds the driver should wait for events to execute before releasing or cancelling the underlying OS requests; please refer to the Timeouts topic for more information. Valid values are 0, which disables event timeouts, and values greater than or equal to 3000. When event timeouts are in effect, event handlers can call reset_timeout to reset the timer if they require additional time to complete.

This method can fail for a number of reasons, including (but not limited to) the following:

• If the class's system driver has not been properly installed, or is awaiting a system reboot (as indicated by the return value of install), this method fails with an ERROR_FILE_NOT_FOUND (2) error code.
• If the initialize method has not been called yet, this method fails with an ERROR_NOT_READY (21) error code.
• If the filter is already active, this method fails with an ERROR_CONNECTION_ACTIVE (1230) error code.
• If an invalid value is passed for Timeout, this method fails with an ERROR_IMPLEMENTATION_LIMIT (1292) error code.

stop_filter Method

This method stops filtering registry operations.

Syntax

def stop_filter() -> None: ...

Remarks

This method detaches the filter, causing the class's driver to stop filtering registry operations. This method will block until all pending requests have completed and the filter has been detached.

suspend_default_rules Method

This method suspends all default rules until the application exits.

Syntax

def suspend_default_rules(product_guid: str) -> bool: ...

Remarks

This method suspends (i.e., deactivates) all default rules associated with the application identified by ProductGUID until the application exits. If the rules are suspended successfully, this method returns True; otherwise, it returns False.

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method.

When the application exits, the class's system driver will reactivate the suspended rules and start enforcing them once again.

toggle_process_protection Method

This method enables or disables termination protection for the application.

Syntax

def toggle_process_protection(enabled: bool) -> bool: ...

Remarks

This method controls the termination protection mechanism, which applications can enable to prevent their process and threads from being terminated. If successful, this method returns True; otherwise, it returns False.

The Enabled parameter specifies whether termination protection should be enabled (True) or disabled (False); it is disabled by default. If termination protection is enabled, an application must disable it before attempting to exit.

Note: When developing a GUI-based application, please keep in mind that the termination protection mechanism does not intercept Windows' notifications like WM_CLOSE or WM_QUIT; applications must intercept and handle such messages themselves if they wish to protect their UI. Please refer to Microsoft's Window Notifications articles for more information.

uninstall Method

This method uninstalls the class's system driver.

Syntax

def uninstall(cab_file_name: str, product_guid: str, installed_path: str, flags: int) -> bool: ...

Remarks

This method is used to uninstall the class's system driver. If the system must be rebooted to complete the uninstallation process, this method returns True; otherwise, it returns False.

Important: To upgrade the class's driver, use only the install method. Previously installed versions of the driver should not be uninstalled first. Calling the install method will upgrade the previously installed version.

Please refer to the Driver Installation topic for more information.

The same values must be passed for the CabFileName, ProductGUID, and InstalledPath parameters as were passed when install was called; please refer to its documentation for more information.

Flags specifies which versions of the class's system driver should be uninstalled and which should be set by ORing together one or more of the following values:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error.

Note: This method cannot be called within events.

on_after_close_key Event

This event fires after a registry key is closed.

Syntax

class CBRegistryAfterCloseKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_close_key() -> Callable[[CBRegistryAfterCloseKeyEventParams], None]: ...
@on_after_close_key.setter
def on_after_close_key(event_hook: Callable[[CBRegistryAfterCloseKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key is closed.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_CLOSE_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_create_key Event

This event fires after a registry key is created.

Syntax

class CBRegistryAfterCreateKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def key_handle() -> int: ...
  @key_handle.setter
  def key_handle(value) -> None: ...

  @property
  def key_handle_context() -> int: ...
  @key_handle_context.setter
  def key_handle_context(value) -> None: ...

  @property
  def granted_access() -> int: ...
  @granted_access.setter
  def granted_access(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_create_key() -> Callable[[CBRegistryAfterCreateKeyEventParams], None]: ...
@on_after_create_key.setter
def on_after_create_key(event_hook: Callable[[CBRegistryAfterCreateKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key is created.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_CREATE_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The KeyHandle parameter specifies a handle to a registry key that should be opened instead of the one this event fired for. Applications can set this parameter to redirect access to the registry key associated with the specified handle.

The KeyHandleContext parameter is a placeholder for application-defined data associated with the application-provided registry key handle. Please refer to the Contexts topic for more information.

The GrantedAccess parameter specifies the granted access rights for an application-provided registry key handle. Applications that set KeyHandle must also set this parameter. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_delete_key Event

This event fires after a registry key is deleted.

Syntax

class CBRegistryAfterDeleteKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_delete_key() -> Callable[[CBRegistryAfterDeleteKeyEventParams], None]: ...
@on_after_delete_key.setter
def on_after_delete_key(event_hook: Callable[[CBRegistryAfterDeleteKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key is deleted.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_DELETE_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_delete_value Event

This event fires after a registry value is deleted.

Syntax

class CBRegistryAfterDeleteValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_delete_value() -> Callable[[CBRegistryAfterDeleteValueEventParams], None]: ...
@on_after_delete_value.setter
def on_after_delete_value(event_hook: Callable[[CBRegistryAfterDeleteValueEventParams], None]) -> None: ...

Remarks

This event fires after a registry value is deleted.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_DELETE_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires. A similar strategy can be applied if the application needs the registry value's name, which can be stored in KeyContext during the corresponding Before* event.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_enumerate_key Event

This event fires after a subkey's information is retrieved during key enumeration.

Syntax

class CBRegistryAfterEnumerateKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def index() -> int: ...

  @property
  def valid_fields() -> int: ...

  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...

  @property
  def name() -> str: ...
  @name.setter
  def name(value) -> None: ...

  @property
  def class_name() -> str: ...
  @class_name.setter
  def class_name(value) -> None: ...

  @property
  def sub_keys() -> int: ...
  @sub_keys.setter
  def sub_keys(value) -> None: ...

  @property
  def max_name_length() -> int: ...
  @max_name_length.setter
  def max_name_length(value) -> None: ...

  @property
  def max_class_name_length() -> int: ...
  @max_class_name_length.setter
  def max_class_name_length(value) -> None: ...

  @property
  def values() -> int: ...
  @values.setter
  def values(value) -> None: ...

  @property
  def max_value_name_length() -> int: ...
  @max_value_name_length.setter
  def max_value_name_length(value) -> None: ...

  @property
  def max_value_data_size() -> int: ...
  @max_value_data_size.setter
  def max_value_data_size(value) -> None: ...

  @property
  def virtualization_candidate() -> bool: ...
  @virtualization_candidate.setter
  def virtualization_candidate(value) -> None: ...

  @property
  def virtualization_enabled() -> bool: ...
  @virtualization_enabled.setter
  def virtualization_enabled(value) -> None: ...

  @property
  def virtual_target() -> bool: ...
  @virtual_target.setter
  def virtual_target(value) -> None: ...

  @property
  def virtual_store() -> bool: ...
  @virtual_store.setter
  def virtual_store(value) -> None: ...

  @property
  def virtual_source() -> bool: ...
  @virtual_source.setter
  def virtual_source(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_enumerate_key() -> Callable[[CBRegistryAfterEnumerateKeyEventParams], None]: ...
@on_after_enumerate_key.setter
def on_after_enumerate_key(event_hook: Callable[[CBRegistryAfterEnumerateKeyEventParams], None]) -> None: ...

Remarks

This event fires after a subkey's information is retrieved during enumeration of a registry key's subkeys.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_ENUM_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Index parameter reflects the zero-based index of the key (within the registry key being enumerated).

The ValidFields parameter indicates which pieces of information about the key were retrieved. The value of this parameter is a combination of one or more of the following:

The LastWriteTime parameter specifies when the key was last changed, specified in UTC.

The Name parameter specifies the key's name. The maximum length of a registry key name is 255 characters.

The ClassName parameter specifies the key's class name. The maximum length of a registry key class name is 255 characters.

The SubKeys parameter specifies the number of subkeys that the key has.

The MaxNameLength parameter specifies the length, in bytes, of the key's longest subkey name.

The MaxClassNameLength parameter specifies the length, in bytes, of the key's longest subkey class name.

The Values parameter specifies the number of values the key has.

The MaxValueNameLength parameter specifies the length, in bytes, of the key's longest value name.

The MaxValueDataSize parameter specifies the length, in bytes, of the subkey's largest value data size.

The VirtualizationCandidate parameter specifies whether the key is part of the virtualization namespace scope.

The VirtualizationEnabled parameter specifies whether virtualization is enabled on the key. This parameter can only be True if VirtualizationCandidate is True.

The VirtualTarget parameter specifies whether the key is a virtual key. This parameter can only be True if both VirtualizationCandidate and VirtualizationEnabled are both False. Its value is only valid on virtual store key handles.

The VirtualStore parameter specifies whether the key is part of the virtual store path.

The VirtualSource parameter specifies whether the key has ever been virtualized. This parameter can only be True if VirtualizationCandidate is True.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_enumerate_value Event

This event fires after a registry value's information is retrieved during key value enumeration.

Syntax

class CBRegistryAfterEnumerateValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def index() -> int: ...

  @property
  def valid_fields() -> int: ...

  @property
  def value_name() -> str: ...
  @value_name.setter
  def value_name(value) -> None: ...

  @property
  def value_type() -> int: ...
  @value_type.setter
  def value_type(value) -> None: ...

  @property
  def integer_value() -> int: ...
  @integer_value.setter
  def integer_value(value) -> None: ...

  @property
  def string_value() -> str: ...
  @string_value.setter
  def string_value(value) -> None: ...

  @property
  def binary_value() -> c_void_p: ...

  @property
  def max_binary_value_size() -> int: ...

  @property
  def binary_value_size() -> int: ...
  @binary_value_size.setter
  def binary_value_size(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_enumerate_value() -> Callable[[CBRegistryAfterEnumerateValueEventParams], None]: ...
@on_after_enumerate_value.setter
def on_after_enumerate_value(event_hook: Callable[[CBRegistryAfterEnumerateValueEventParams], None]) -> None: ...

Remarks

This event fires after a registry value's information is retrieved during enumeration of a registry key's values.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_ENUM_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Index parameter reflects the zero-based index of the registry value (within the registry key being enumerated).

The ValidFields parameter indicates which pieces of information about the registry value were retrieved. The value of this parameter is a combination of one or more of the following:

The ValueName parameter specifies the registry value's name.

The ValueType parameter specifies the registry value's type and determines which of the other parameters holds the registry value's data (please refer to their descriptions for more information). Possible values are as follows:

The IntegerValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_DWORD or REG_VALUETYPE_QWORD.

The StringValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_SZ, REG_VALUETYPE_EXPAND_SZ, or REG_VALUETYPE_MULTI_SZ.

For REG_VALUETYPE_MULTI_SZ, data are formatted as multiple individual ETB-terminated strings concatenated together into a single null-terminated string (where ETB is the End-of-Transmission-Block character; 23/0x17). For example, the strings This is, a multistring, and value. would be encoded as This is[ETB]a multistring[ETB]value.[ETB][NUL].

Note: As Microsoft's Registry Value Types article describes, the native multistring data format uses null terminators for the individual strings (e.g., This is[NUL]a multistring[NUL]value.[NUL][NUL]); CBRegistry converts the individual null terminators to/from ETB characters internally for applications' convenience.

The BinaryValue parameter points to a memory buffer that holds the registry value's data if ValueType is REG_VALUETYPE_BINARY. The MaxBinaryValueSize and BinaryValueSize parameter specify the capacity of the BinaryValue buffer and the length of the data it contains, respectively, in bytes.

Always check MaxBinaryValueSize before copying any data into the BinaryValue buffer. If the buffer is large enough to hold all of the data, copy the data into it, and then update BinaryValueSize accordingly. If the buffer is not large enough, do not copy any data into it; instead, set BinaryValueSize to the required buffer size (i.e., the size of the data) and return the ERROR_MORE_DATA (234) error code via ResultCode.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_get_key_security Event

This event fires after a registry key's security attributes are changed.

Syntax

class CBRegistryAfterGetKeySecurityEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def length_needed() -> int: ...
  @length_needed.setter
  def length_needed(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_get_key_security() -> Callable[[CBRegistryAfterGetKeySecurityEventParams], None]: ...
@on_after_get_key_security.setter
def on_after_get_key_security(event_hook: Callable[[CBRegistryAfterGetKeySecurityEventParams], None]) -> None: ...

Remarks

This event fires after security attributes are changed for the registry key specified by KeyContext.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_GET_KEY_SECURITY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The SecurityInformation parameter indicates which pieces of security information were requested. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that, if the request was successful, contains the requested security information. The Length parameter reflects the length of the data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

Applications that wish to modify the security information may do so by replacing the data in the SecurityDescriptor buffer. If the current Length is too small to accommodate the new security information, set LengthNeeded to the number of bytes necessary to hold the data, and return the ERROR_INSUFFICIENT_BUFFER error code via ResultCode.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_open_key Event

This event fires after a registry key is opened.

Syntax

class CBRegistryAfterOpenKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def key_handle() -> int: ...
  @key_handle.setter
  def key_handle(value) -> None: ...

  @property
  def key_handle_context() -> int: ...
  @key_handle_context.setter
  def key_handle_context(value) -> None: ...

  @property
  def granted_access() -> int: ...
  @granted_access.setter
  def granted_access(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_open_key() -> Callable[[CBRegistryAfterOpenKeyEventParams], None]: ...
@on_after_open_key.setter
def on_after_open_key(event_hook: Callable[[CBRegistryAfterOpenKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key is opened.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_OPEN_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The KeyHandle parameter specifies a handle to a registry key that should be opened instead of the one this event fired for. Applications can set this parameter to redirect access to the registry key associated with the specified handle.

The KeyHandleContext parameter is a placeholder for application-defined data associated with the application-provided registry key handle. Please refer to the Contexts topic for more information.

The GrantedAccess parameter specifies the granted access rights for an application-provided registry key handle. Applications that set KeyHandle must also set this parameter. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_query_key Event

This event fires after a registry key's information is retrieved.

Syntax

class CBRegistryAfterQueryKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def valid_fields() -> int: ...

  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...

  @property
  def name() -> str: ...
  @name.setter
  def name(value) -> None: ...

  @property
  def class_name() -> str: ...
  @class_name.setter
  def class_name(value) -> None: ...

  @property
  def sub_keys() -> int: ...
  @sub_keys.setter
  def sub_keys(value) -> None: ...

  @property
  def max_name_length() -> int: ...
  @max_name_length.setter
  def max_name_length(value) -> None: ...

  @property
  def max_class_name_length() -> int: ...
  @max_class_name_length.setter
  def max_class_name_length(value) -> None: ...

  @property
  def values() -> int: ...
  @values.setter
  def values(value) -> None: ...

  @property
  def max_value_name_length() -> int: ...
  @max_value_name_length.setter
  def max_value_name_length(value) -> None: ...

  @property
  def max_value_data_size() -> int: ...
  @max_value_data_size.setter
  def max_value_data_size(value) -> None: ...

  @property
  def virtualization_candidate() -> bool: ...
  @virtualization_candidate.setter
  def virtualization_candidate(value) -> None: ...

  @property
  def virtualization_enabled() -> bool: ...
  @virtualization_enabled.setter
  def virtualization_enabled(value) -> None: ...

  @property
  def virtual_target() -> bool: ...
  @virtual_target.setter
  def virtual_target(value) -> None: ...

  @property
  def virtual_store() -> bool: ...
  @virtual_store.setter
  def virtual_store(value) -> None: ...

  @property
  def virtual_source() -> bool: ...
  @virtual_source.setter
  def virtual_source(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_query_key() -> Callable[[CBRegistryAfterQueryKeyEventParams], None]: ...
@on_after_query_key.setter
def on_after_query_key(event_hook: Callable[[CBRegistryAfterQueryKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key's information is retrieved.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_QUERY_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The ValidFields parameter indicates which pieces of information about the key were retrieved. The value of this parameter is a combination of one or more of the following:

The LastWriteTime parameter specifies when the key was last changed, specified in UTC.

The Name parameter specifies the key's name. The maximum length of a registry key name is 255 characters.

The ClassName parameter specifies the key's class name. The maximum length of a registry key class name is 255 characters.

The SubKeys parameter specifies the number of subkeys that the key has.

The MaxNameLength parameter specifies the length, in bytes, of the key's longest subkey name.

The MaxClassNameLength parameter specifies the length, in bytes, of the key's longest subkey class name.

The Values parameter specifies the number of values the key has.

The MaxValueNameLength parameter specifies the length, in bytes, of the key's longest value name.

The MaxValueDataSize parameter specifies the length, in bytes, of the subkey's largest value data size.

The VirtualizationCandidate parameter specifies whether the key is part of the virtualization namespace scope.

The VirtualizationEnabled parameter specifies whether virtualization is enabled on the key. This parameter can only be True if VirtualizationCandidate is True.

The VirtualTarget parameter specifies whether the key is a virtual key. This parameter can only be True if both VirtualizationCandidate and VirtualizationEnabled are both False. Its value is only valid on virtual store key handles.

The VirtualStore parameter specifies whether the key is part of the virtual store path.

The VirtualSource parameter specifies whether the key has ever been virtualized. This parameter can only be True if VirtualizationCandidate is True.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_query_value Event

This event fires after a registry value's information is retrieved.

Syntax

class CBRegistryAfterQueryValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def value_name() -> str: ...

  @property
  def valid_fields() -> int: ...

  @property
  def value_type() -> int: ...
  @value_type.setter
  def value_type(value) -> None: ...

  @property
  def integer_value() -> int: ...
  @integer_value.setter
  def integer_value(value) -> None: ...

  @property
  def string_value() -> str: ...
  @string_value.setter
  def string_value(value) -> None: ...

  @property
  def binary_value() -> c_void_p: ...

  @property
  def max_binary_value_size() -> int: ...

  @property
  def binary_value_size() -> int: ...
  @binary_value_size.setter
  def binary_value_size(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_query_value() -> Callable[[CBRegistryAfterQueryValueEventParams], None]: ...
@on_after_query_value.setter
def on_after_query_value(event_hook: Callable[[CBRegistryAfterQueryValueEventParams], None]) -> None: ...

Remarks

This event fires after a registry value's information is retrieved.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_QUERY_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The ValueName parameter reflects the name of the registry value.

The ValidFields parameter indicates which pieces of information about the registry value were retrieved. The value of this parameter is a combination of one or more of the following:

The ValueType parameter specifies the registry value's type and determines which of the other parameters holds the registry value's data (please refer to their descriptions for more information). Possible values are as follows:

The IntegerValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_DWORD or REG_VALUETYPE_QWORD.

The StringValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_SZ, REG_VALUETYPE_EXPAND_SZ, or REG_VALUETYPE_MULTI_SZ.

For REG_VALUETYPE_MULTI_SZ, data are formatted as multiple individual ETB-terminated strings concatenated together into a single null-terminated string (where ETB is the End-of-Transmission-Block character; 23/0x17). For example, the strings This is, a multistring, and value. would be encoded as This is[ETB]a multistring[ETB]value.[ETB][NUL].

Note: As Microsoft's Registry Value Types article describes, the native multistring data format uses null terminators for the individual strings (e.g., This is[NUL]a multistring[NUL]value.[NUL][NUL]); CBRegistry converts the individual null terminators to/from ETB characters internally for applications' convenience.

The BinaryValue parameter points to a memory buffer that holds the registry value's data if ValueType is REG_VALUETYPE_BINARY. The MaxBinaryValueSize and BinaryValueSize parameter specify the capacity of the BinaryValue buffer and the length of the data it contains, respectively, in bytes.

Always check MaxBinaryValueSize before copying any data into the BinaryValue buffer. If the buffer is large enough to hold all of the data, copy the data into it, and then update BinaryValueSize accordingly. If the buffer is not large enough, do not copy any data into it; instead, set BinaryValueSize to the required buffer size (i.e., the size of the data) and return the ERROR_MORE_DATA (234) error code via ResultCode.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_rename_key Event

This event fires after a registry key is renamed.

Syntax

class CBRegistryAfterRenameKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_rename_key() -> Callable[[CBRegistryAfterRenameKeyEventParams], None]: ...
@on_after_rename_key.setter
def on_after_rename_key(event_hook: Callable[[CBRegistryAfterRenameKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key is renamed.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_RENAME_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's old or new names for performance reasons; applications that need them should store them in KeyContext during the on_before_create_key/on_before_open_key and on_before_rename_key events so that they can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_key Event

This event fires after a registry key's information is updated.

Syntax

class CBRegistryAfterSetKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_set_key() -> Callable[[CBRegistryAfterSetKeyEventParams], None]: ...
@on_after_set_key.setter
def on_after_set_key(event_hook: Callable[[CBRegistryAfterSetKeyEventParams], None]) -> None: ...

Remarks

This event fires after a registry key's information is updated.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_SET_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_key_security Event

This event fires after a registry key's security attributes are changed.

Syntax

class CBRegistryAfterSetKeySecurityEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_set_key_security() -> Callable[[CBRegistryAfterSetKeySecurityEventParams], None]: ...
@on_after_set_key_security.setter
def on_after_set_key_security(event_hook: Callable[[CBRegistryAfterSetKeySecurityEventParams], None]) -> None: ...

Remarks

This event fires after security attributes are changed for the registry key specified by KeyContext.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_SET_KEY_SECURITY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, were to be set. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that contains the new security information. The Length parameter reflects the length of this data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_value Event

This event fires after a registry value is set or updated.

Syntax

class CBRegistryAfterSetValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_after_set_value() -> Callable[[CBRegistryAfterSetValueEventParams], None]: ...
@on_after_set_value.setter
def on_after_set_value(event_hook: Callable[[CBRegistryAfterSetValueEventParams], None]) -> None: ...

Remarks

This event fires after a registry value is set or updated.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_AFTER_SET_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires. A similar strategy can be applied if the application needs the registry value's name, which can be stored in KeyContext during the corresponding Before* event.

The Status parameter contains a Win32 error code that indicates the outcome of the operation; 0 indicates success. This value is returned to the request originator if no other status is returned from this event. Applications may change this parameter's value if they want a different Win32 error code to be returned.

The Processed parameter indicates whether the response values have been modified. Applications must set this parameter to True if they have altered any of the parameters related to the response values.

Note: This parameter's value is ignored if an error is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_close_key Event

This event fires before a registry key is closed.

Syntax

class CBRegistryBeforeCloseKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_close_key() -> Callable[[CBRegistryBeforeCloseKeyEventParams], None]: ...
@on_before_close_key.setter
def on_before_close_key(event_hook: Callable[[CBRegistryBeforeCloseKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key is closed.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_CLOSE_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_create_key Event

This event fires before a registry key is created.

Syntax

class CBRegistryBeforeCreateKeyEventParams(object):
  @property
  def full_name() -> str: ...

  @property
  def desired_access() -> int: ...

  @property
  def key_handle() -> int: ...
  @key_handle.setter
  def key_handle(value) -> None: ...

  @property
  def key_handle_context() -> int: ...
  @key_handle_context.setter
  def key_handle_context(value) -> None: ...

  @property
  def granted_access() -> int: ...
  @granted_access.setter
  def granted_access(value) -> None: ...

  @property
  def key_context() -> int: ...
  @key_context.setter
  def key_context(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_create_key() -> Callable[[CBRegistryBeforeCreateKeyEventParams], None]: ...
@on_before_create_key.setter
def on_before_create_key(event_hook: Callable[[CBRegistryBeforeCreateKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key is created.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_CREATE_KEY flag.

The FullName parameter reflects the "full" name of the registry key being created, specified, by default, in system format (e.g., HKEY_LOCAL_MACHINE\System\... will be \Registry\Machine\System\...). If the ResolveNtNameToWin32Name configuration setting is enabled, the name will be converted to the more common Win32 format. Applications that intend to use the registry key's name during later events should store it in KeyContext during this event. Please refer to the Contexts topic for more information.

The DesiredAccess parameter reflects the access rights specified by the requestor. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The KeyHandle parameter specifies a handle to a registry key that should be opened instead of the one this event fired for. Applications can set this parameter to redirect access to the registry key associated with the specified handle.

The KeyHandleContext parameter is a placeholder for application-defined data associated with the application-provided registry key handle. Please refer to the Contexts topic for more information.

The GrantedAccess parameter specifies the granted access rights for an application-provided registry key handle. Applications that set KeyHandle must also set this parameter. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_delete_key Event

This event fires before a registry key is deleted.

Syntax

class CBRegistryBeforeDeleteKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_delete_key() -> Callable[[CBRegistryBeforeDeleteKeyEventParams], None]: ...
@on_before_delete_key.setter
def on_before_delete_key(event_hook: Callable[[CBRegistryBeforeDeleteKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key is deleted.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_DELETE_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_delete_value Event

This event fires before a registry value is deleted.

Syntax

class CBRegistryBeforeDeleteValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def value_name() -> str: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_delete_value() -> Callable[[CBRegistryBeforeDeleteValueEventParams], None]: ...
@on_before_delete_value.setter
def on_before_delete_value(event_hook: Callable[[CBRegistryBeforeDeleteValueEventParams], None]) -> None: ...

Remarks

This event fires before a registry value is deleted.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_DELETE_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The ValueName parameter reflects the name of the registry value. Applications that intend to use the registry value's name during later events should store it in KeyContext during this event. Please refer to the Contexts topic for more information.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_enumerate_key Event

This event fires before a subkey's information is retrieved during key enumeration.

Syntax

class CBRegistryBeforeEnumerateKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def index() -> int: ...

  @property
  def requested_fields() -> int: ...

  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...

  @property
  def name() -> str: ...
  @name.setter
  def name(value) -> None: ...

  @property
  def class_name() -> str: ...
  @class_name.setter
  def class_name(value) -> None: ...

  @property
  def sub_keys() -> int: ...
  @sub_keys.setter
  def sub_keys(value) -> None: ...

  @property
  def max_name_length() -> int: ...
  @max_name_length.setter
  def max_name_length(value) -> None: ...

  @property
  def max_class_name_length() -> int: ...
  @max_class_name_length.setter
  def max_class_name_length(value) -> None: ...

  @property
  def values() -> int: ...
  @values.setter
  def values(value) -> None: ...

  @property
  def max_value_name_length() -> int: ...
  @max_value_name_length.setter
  def max_value_name_length(value) -> None: ...

  @property
  def max_value_data_size() -> int: ...
  @max_value_data_size.setter
  def max_value_data_size(value) -> None: ...

  @property
  def virtualization_candidate() -> bool: ...
  @virtualization_candidate.setter
  def virtualization_candidate(value) -> None: ...

  @property
  def virtualization_enabled() -> bool: ...
  @virtualization_enabled.setter
  def virtualization_enabled(value) -> None: ...

  @property
  def virtual_target() -> bool: ...
  @virtual_target.setter
  def virtual_target(value) -> None: ...

  @property
  def virtual_store() -> bool: ...
  @virtual_store.setter
  def virtual_store(value) -> None: ...

  @property
  def virtual_source() -> bool: ...
  @virtual_source.setter
  def virtual_source(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_enumerate_key() -> Callable[[CBRegistryBeforeEnumerateKeyEventParams], None]: ...
@on_before_enumerate_key.setter
def on_before_enumerate_key(event_hook: Callable[[CBRegistryBeforeEnumerateKeyEventParams], None]) -> None: ...

Remarks

This event fires before a subkey's information is retrieved during enumeration of a registry key's subkeys.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_ENUM_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Index parameter reflects the zero-based index of the key (within the registry key being enumerated).

The RequestedFields parameter indicates which pieces of information about the key were requested. The value of this parameter is a combination of one or more of the following:

The LastWriteTime parameter specifies when the key was last changed, specified in UTC.

The Name parameter specifies the key's name. The maximum length of a registry key name is 255 characters.

The ClassName parameter specifies the key's class name. The maximum length of a registry key class name is 255 characters.

The SubKeys parameter specifies the number of subkeys that the key has.

The MaxNameLength parameter specifies the length, in bytes, of the key's longest subkey name.

The MaxClassNameLength parameter specifies the length, in bytes, of the key's longest subkey class name.

The Values parameter specifies the number of values the key has.

The MaxValueNameLength parameter specifies the length, in bytes, of the key's longest value name.

The MaxValueDataSize parameter specifies the length, in bytes, of the subkey's largest value data size.

The VirtualizationCandidate parameter specifies whether the key is part of the virtualization namespace scope.

The VirtualizationEnabled parameter specifies whether virtualization is enabled on the key. This parameter can only be True if VirtualizationCandidate is True.

The VirtualTarget parameter specifies whether the key is a virtual key. This parameter can only be True if both VirtualizationCandidate and VirtualizationEnabled are both False. Its value is only valid on virtual store key handles.

The VirtualStore parameter specifies whether the key is part of the virtual store path.

The VirtualSource parameter specifies whether the key has ever been virtualized. This parameter can only be True if VirtualizationCandidate is True.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_enumerate_value Event

This event fires before a registry value's information is retrieved during key value enumeration.

Syntax

class CBRegistryBeforeEnumerateValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def index() -> int: ...

  @property
  def requested_fields() -> int: ...

  @property
  def value_name() -> str: ...
  @value_name.setter
  def value_name(value) -> None: ...

  @property
  def value_type() -> int: ...
  @value_type.setter
  def value_type(value) -> None: ...

  @property
  def integer_value() -> int: ...
  @integer_value.setter
  def integer_value(value) -> None: ...

  @property
  def string_value() -> str: ...
  @string_value.setter
  def string_value(value) -> None: ...

  @property
  def binary_value() -> c_void_p: ...

  @property
  def max_binary_value_size() -> int: ...

  @property
  def binary_value_size() -> int: ...
  @binary_value_size.setter
  def binary_value_size(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_enumerate_value() -> Callable[[CBRegistryBeforeEnumerateValueEventParams], None]: ...
@on_before_enumerate_value.setter
def on_before_enumerate_value(event_hook: Callable[[CBRegistryBeforeEnumerateValueEventParams], None]) -> None: ...

Remarks

This event fires before a registry value's information is retrieved during enumeration of a registry key's values.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_ENUM_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The Index parameter reflects the zero-based index of the registry value (within the registry key being enumerated).

The RequestedFields parameter indicates which pieces of information about the registry value were requested. The value of this parameter is a combination of one or more of the following:

The ValueName parameter specifies the registry value's name.

The ValueType parameter specifies the registry value's type and determines which of the other parameters holds the registry value's data (please refer to their descriptions for more information). Possible values are as follows:

The IntegerValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_DWORD or REG_VALUETYPE_QWORD.

The StringValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_SZ, REG_VALUETYPE_EXPAND_SZ, or REG_VALUETYPE_MULTI_SZ.

For REG_VALUETYPE_MULTI_SZ, data are formatted as multiple individual ETB-terminated strings concatenated together into a single null-terminated string (where ETB is the End-of-Transmission-Block character; 23/0x17). For example, the strings This is, a multistring, and value. would be encoded as This is[ETB]a multistring[ETB]value.[ETB][NUL].

Note: As Microsoft's Registry Value Types article describes, the native multistring data format uses null terminators for the individual strings (e.g., This is[NUL]a multistring[NUL]value.[NUL][NUL]); CBRegistry converts the individual null terminators to/from ETB characters internally for applications' convenience.

The BinaryValue parameter points to a memory buffer that holds the registry value's data if ValueType is REG_VALUETYPE_BINARY. The MaxBinaryValueSize and BinaryValueSize parameter specify the capacity of the BinaryValue buffer and the length of the data it contains, respectively, in bytes.

Always check MaxBinaryValueSize before copying any data into the BinaryValue buffer. If the buffer is large enough to hold all of the data, copy the data into it, and then update BinaryValueSize accordingly. If the buffer is not large enough, do not copy any data into it; instead, set BinaryValueSize to the required buffer size (i.e., the size of the data) and return the ERROR_MORE_DATA (234) error code via ResultCode.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_get_key_security Event

This event fires before a registry key's security attributes are retrieved.

Syntax

class CBRegistryBeforeGetKeySecurityEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def length_needed() -> int: ...
  @length_needed.setter
  def length_needed(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_get_key_security() -> Callable[[CBRegistryBeforeGetKeySecurityEventParams], None]: ...
@on_before_get_key_security.setter
def on_before_get_key_security(event_hook: Callable[[CBRegistryBeforeGetKeySecurityEventParams], None]) -> None: ...

Remarks

This event fires before security attributes are retrieved for the registry key specified by KeyContext.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_GET_KEY_SECURITY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The SecurityInformation parameter indicates which pieces of security information are requested. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that receives the requested security information. The buffer referenced by the SecurityDescriptor parameter may be modified by the event handler if the operation is completed without passing it further to other filters and the filesystem driver. The Length parameter reflects the capacity of the SecurityDescriptor buffer, in bytes.

If the capacity reflected by the Length parameter is not sufficient to accommodate the security information, set LengthNeeded to the number of bytes necessary to hold the data, and return the ERROR_INSUFFICIENT_BUFFER error code via ResultCode.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The returned data will be formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_open_key Event

This event fires before a registry key is opened.

Syntax

class CBRegistryBeforeOpenKeyEventParams(object):
  @property
  def full_name() -> str: ...

  @property
  def desired_access() -> int: ...

  @property
  def key_handle() -> int: ...
  @key_handle.setter
  def key_handle(value) -> None: ...

  @property
  def key_handle_context() -> int: ...
  @key_handle_context.setter
  def key_handle_context(value) -> None: ...

  @property
  def granted_access() -> int: ...
  @granted_access.setter
  def granted_access(value) -> None: ...

  @property
  def key_context() -> int: ...
  @key_context.setter
  def key_context(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_open_key() -> Callable[[CBRegistryBeforeOpenKeyEventParams], None]: ...
@on_before_open_key.setter
def on_before_open_key(event_hook: Callable[[CBRegistryBeforeOpenKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key is opened.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_OPEN_KEY flag.

The FullName parameter reflects the "full" name of the registry key being opened, specified, by default, in system format (e.g., HKEY_LOCAL_MACHINE\System\... will be \Registry\Machine\System\...). If the ResolveNtNameToWin32Name configuration setting is enabled, the name will be converted to the more common Win32 format. Applications that intend to use the registry key's name during later events should store it in KeyContext during this event. Please refer to the Contexts topic for more information.

The DesiredAccess parameter reflects the access rights specified by the requestor. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The KeyHandle parameter specifies a handle to a registry key that should be opened instead of the one this event fired for. Applications can set this parameter to redirect access to the registry key associated with the specified handle.

The KeyHandleContext parameter is a placeholder for application-defined data associated with the application-provided registry key handle. Please refer to the Contexts topic for more information.

The GrantedAccess parameter specifies the granted access rights for an application-provided registry key handle. Applications that set KeyHandle must also set this parameter. Please refer to Microsoft's Registry Key Security and Access Rights article for more information about possible values.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_query_key Event

This event fires before a registry key's information is retrieved.

Syntax

class CBRegistryBeforeQueryKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def requested_fields() -> int: ...

  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...

  @property
  def name() -> str: ...
  @name.setter
  def name(value) -> None: ...

  @property
  def class_name() -> str: ...
  @class_name.setter
  def class_name(value) -> None: ...

  @property
  def sub_keys() -> int: ...
  @sub_keys.setter
  def sub_keys(value) -> None: ...

  @property
  def max_name_length() -> int: ...
  @max_name_length.setter
  def max_name_length(value) -> None: ...

  @property
  def max_class_name_length() -> int: ...
  @max_class_name_length.setter
  def max_class_name_length(value) -> None: ...

  @property
  def values() -> int: ...
  @values.setter
  def values(value) -> None: ...

  @property
  def max_value_name_length() -> int: ...
  @max_value_name_length.setter
  def max_value_name_length(value) -> None: ...

  @property
  def max_value_data_size() -> int: ...
  @max_value_data_size.setter
  def max_value_data_size(value) -> None: ...

  @property
  def virtualization_candidate() -> bool: ...
  @virtualization_candidate.setter
  def virtualization_candidate(value) -> None: ...

  @property
  def virtualization_enabled() -> bool: ...
  @virtualization_enabled.setter
  def virtualization_enabled(value) -> None: ...

  @property
  def virtual_target() -> bool: ...
  @virtual_target.setter
  def virtual_target(value) -> None: ...

  @property
  def virtual_store() -> bool: ...
  @virtual_store.setter
  def virtual_store(value) -> None: ...

  @property
  def virtual_source() -> bool: ...
  @virtual_source.setter
  def virtual_source(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_query_key() -> Callable[[CBRegistryBeforeQueryKeyEventParams], None]: ...
@on_before_query_key.setter
def on_before_query_key(event_hook: Callable[[CBRegistryBeforeQueryKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key's information is retrieved.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_QUERY_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The RequestedFields parameter indicates which pieces of information about the key were requested. The value of this parameter is a combination of one or more of the following:

The LastWriteTime parameter specifies when the key was last changed, specified in UTC.

The Name parameter specifies the key's name. The maximum length of a registry key name is 255 characters.

The ClassName parameter specifies the key's class name. The maximum length of a registry key class name is 255 characters.

The SubKeys parameter specifies the number of subkeys that the key has.

The MaxNameLength parameter specifies the length, in bytes, of the key's longest subkey name.

The MaxClassNameLength parameter specifies the length, in bytes, of the key's longest subkey class name.

The Values parameter specifies the number of values the key has.

The MaxValueNameLength parameter specifies the length, in bytes, of the key's longest value name.

The MaxValueDataSize parameter specifies the length, in bytes, of the subkey's largest value data size.

The VirtualizationCandidate parameter specifies whether the key is part of the virtualization namespace scope.

The VirtualizationEnabled parameter specifies whether virtualization is enabled on the key. This parameter can only be True if VirtualizationCandidate is True.

The VirtualTarget parameter specifies whether the key is a virtual key. This parameter can only be True if both VirtualizationCandidate and VirtualizationEnabled are both False. Its value is only valid on virtual store key handles.

The VirtualStore parameter specifies whether the key is part of the virtual store path.

The VirtualSource parameter specifies whether the key has ever been virtualized. This parameter can only be True if VirtualizationCandidate is True.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_query_value Event

This event fires before a registry value's information is retrieved.

Syntax

class CBRegistryBeforeQueryValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def value_name() -> str: ...

  @property
  def requested_fields() -> int: ...

  @property
  def value_type() -> int: ...
  @value_type.setter
  def value_type(value) -> None: ...

  @property
  def integer_value() -> int: ...
  @integer_value.setter
  def integer_value(value) -> None: ...

  @property
  def string_value() -> str: ...
  @string_value.setter
  def string_value(value) -> None: ...

  @property
  def binary_value() -> c_void_p: ...

  @property
  def max_binary_value_size() -> int: ...

  @property
  def binary_value_size() -> int: ...
  @binary_value_size.setter
  def binary_value_size(value) -> None: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_query_value() -> Callable[[CBRegistryBeforeQueryValueEventParams], None]: ...
@on_before_query_value.setter
def on_before_query_value(event_hook: Callable[[CBRegistryBeforeQueryValueEventParams], None]) -> None: ...

Remarks

This event fires before a registry value's information is retrieved.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_QUERY_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The ValueName parameter reflects the name of the registry value.

The RequestedFields parameter indicates which pieces of information about the registry value were requested. The value of this parameter is a combination of one or more of the following:

The ValueType parameter specifies the registry value's type and determines which of the other parameters holds the registry value's data (please refer to their descriptions for more information). Possible values are as follows:

The IntegerValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_DWORD or REG_VALUETYPE_QWORD.

The StringValue parameter specifies the registry value's data if ValueType is REG_VALUETYPE_SZ, REG_VALUETYPE_EXPAND_SZ, or REG_VALUETYPE_MULTI_SZ.

For REG_VALUETYPE_MULTI_SZ, data are formatted as multiple individual ETB-terminated strings concatenated together into a single null-terminated string (where ETB is the End-of-Transmission-Block character; 23/0x17). For example, the strings This is, a multistring, and value. would be encoded as This is[ETB]a multistring[ETB]value.[ETB][NUL].

Note: As Microsoft's Registry Value Types article describes, the native multistring data format uses null terminators for the individual strings (e.g., This is[NUL]a multistring[NUL]value.[NUL][NUL]); CBRegistry converts the individual null terminators to/from ETB characters internally for applications' convenience.

The BinaryValue parameter points to a memory buffer that holds the registry value's data if ValueType is REG_VALUETYPE_BINARY. The MaxBinaryValueSize and BinaryValueSize parameter specify the capacity of the BinaryValue buffer and the length of the data it contains, respectively, in bytes.

Always check MaxBinaryValueSize before copying any data into the BinaryValue buffer. If the buffer is large enough to hold all of the data, copy the data into it, and then update BinaryValueSize accordingly. If the buffer is not large enough, do not copy any data into it; instead, set BinaryValueSize to the required buffer size (i.e., the size of the data) and return the ERROR_MORE_DATA (234) error code via ResultCode.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_rename_key Event

This event fires before a registry key is renamed.

Syntax

class CBRegistryBeforeRenameKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def new_name() -> str: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_rename_key() -> Callable[[CBRegistryBeforeRenameKeyEventParams], None]: ...
@on_before_rename_key.setter
def on_before_rename_key(event_hook: Callable[[CBRegistryBeforeRenameKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key is renamed.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_RENAME_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The NewName parameter reflects the new name of the registry key. Applications that intend to use the new name during later events should store it in KeyContext during this event; please refer to the Contexts topic for more information.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_set_key Event

This event fires before a registry key's information is updated.

Syntax

class CBRegistryBeforeSetKeyEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def last_write_time() -> datetime.datetime: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_set_key() -> Callable[[CBRegistryBeforeSetKeyEventParams], None]: ...
@on_before_set_key.setter
def on_before_set_key(event_hook: Callable[[CBRegistryBeforeSetKeyEventParams], None]) -> None: ...

Remarks

This event fires before a registry key's information is updated.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_SET_KEY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The LastWriteTime parameter reflects when the key was last changed, specified in UTC.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_set_key_security Event

This event fires before a registry key's security attributes are changed.

Syntax

class CBRegistryBeforeSetKeySecurityEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_set_key_security() -> Callable[[CBRegistryBeforeSetKeySecurityEventParams], None]: ...
@on_before_set_key_security.setter
def on_before_set_key_security(event_hook: Callable[[CBRegistryBeforeSetKeySecurityEventParams], None]) -> None: ...

Remarks

This event fires before security attributes are changed for the registry key specified by KeyContext.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_SET_KEY_SECURITY flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, will be set. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that specifies the new security information. The buffer referenced by the SecurityDescriptor parameter may be modified when needed if the request is to be passed further to other filters and the filesystem driver. The Length parameter reflects the length of the data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The returned data will be formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_set_value Event

This event fires before a registry value is set or updated.

Syntax

class CBRegistryBeforeSetValueEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def value_name() -> str: ...

  @property
  def value_type() -> int: ...

  @property
  def integer_value() -> int: ...

  @property
  def string_value() -> str: ...

  @property
  def binary_value() -> c_void_p: ...

  @property
  def binary_value_size() -> int: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def fire_after_event() -> bool: ...
  @fire_after_event.setter
  def fire_after_event(value) -> None: ...

  @property
  def stop_filtering() -> bool: ...
  @stop_filtering.setter
  def stop_filtering(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_before_set_value() -> Callable[[CBRegistryBeforeSetValueEventParams], None]: ...
@on_before_set_value.setter
def on_before_set_value(event_hook: Callable[[CBRegistryBeforeSetValueEventParams], None]) -> None: ...

Remarks

This event fires before a registry value is set or updated.

Applications need to handle this event only if they have added a standard filter rule that includes [the TBD]. REG_CE_BEFORE_SET_VALUE flag.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

Note: This event does not expose the registry key's name for performance reasons; applications that need it should store it in KeyContext during the on_before_create_key/on_before_open_key event so that it can be retrieved when this event fires.

The ValueName parameter reflects the name of the registry value. Applications that intend to use the registry value's name during later events should store it in KeyContext during this event. Please refer to the Contexts topic for more information.

The ValueType parameter reflects the registry value's type and determines which of the other parameters holds the registry value's data; please refer to their descriptions for more information. Possible values are as follows:

The IntegerValue parameter reflects the registry value's data if ValueType is REG_VALUETYPE_DWORD or REG_VALUETYPE_QWORD.

The StringValue parameter reflects the registry value's data if ValueType is REG_VALUETYPE_SZ, REG_VALUETYPE_EXPAND_SZ, or REG_VALUETYPE_MULTI_SZ.

For REG_VALUETYPE_MULTI_SZ, data are formatted as multiple individual ETB-terminated strings concatenated together into a single null-terminated string (where ETB is the End-of-Transmission-Block character; 23/0x17). For example, the strings This is, a multistring, and value. would be encoded as This is[ETB]a multistring[ETB]value.[ETB][NUL].

Note: As Microsoft's Registry Value Types article describes, the native multistring data format uses null terminators for the individual strings (e.g., This is[NUL]a multistring[NUL]value.[NUL][NUL]); CBRegistry converts the individual null terminators to/from ETB characters internally for applications' convenience.

The BinaryValue parameter points to a memory buffer that holds the registry value's data if ValueType is REG_VALUETYPE_BINARY. The BinaryValueSize parameter reflects the length of the data, in bytes.

The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to True if they have handled the request themselves (this will prevent the corresponding After* event from being called).

Note: This parameter's value is ignored if an error is returned via ResultCode.

The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is True by default.

Note: Regardless of how this parameter is set, the corresponding After* event will not fire if Processed is True, or if an error code is returned via ResultCode.

The StopFiltering parameter specifies whether the class's system driver should ignore all further operations for the registry key; it is False by default. Applications may set this parameter to True to prevent any further events from firing for the registry key.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_cleanup_key_context Event

This event fires when the application-defined data stored in a registry key context need to be cleaned up.

Syntax

class CBRegistryCleanupKeyContextEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_cleanup_key_context() -> Callable[[CBRegistryCleanupKeyContextEventParams], None]: ...
@on_cleanup_key_context.setter
def on_cleanup_key_context(event_hook: Callable[[CBRegistryCleanupKeyContextEventParams], None]) -> None: ...

Remarks

This event fires when the specified KeyContext is about to be discarded, giving applications a chance to clean up any information stored in it. Please refer to the Contexts topic for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_close_key_handle Event

This event fires when an application-provided registry key handle should be closed.

Syntax

class CBRegistryCloseKeyHandleEventParams(object):
  @property
  def key_context() -> int: ...

  @property
  def key_handle() -> int: ...

  @property
  def key_handle_context() -> int: ...

  @property
  def error() -> int: ...

  @property
  def processed() -> bool: ...
  @processed.setter
  def processed(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_close_key_handle() -> Callable[[CBRegistryCloseKeyHandleEventParams], None]: ...
@on_close_key_handle.setter
def on_close_key_handle(event_hook: Callable[[CBRegistryCloseKeyHandleEventParams], None]) -> None: ...

Remarks

This event fires when the application-provided registry key handle, specified by KeyHandle, should be closed and the associated KeyHandleContext should be cleaned up.

The KeyContext parameter is a placeholder for application-defined data associated with the registry key. Please refer to the Contexts topic for more information.

The Error parameter reflects the error code of any error that occurred while using the application-provided key handle.

The Processed parameter indicates whether the application has processed the event and closed the key handle; it is False by default. If the application does not set this parameter to True, then the class will close the KeyHandle with the Windows API's RegCloseKey function when the event handler returns (unless an error code is returned via ResultCode).

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_error Event

This event fires if an unhandled error occurs during an event.

Syntax

class CBRegistryErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CBRegistry:
@property
def on_error() -> Callable[[CBRegistryErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CBRegistryErrorEventParams], None]) -> None: ...

Remarks

This event fires if an unhandled error occurs during another event. Developers can use this information to track down unhandled errors in an application's event handlers.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

on_worker_thread_creation Event

Fires just after a new worker thread is created.

Syntax

class CBRegistryWorkerThreadCreationEventParams(object):
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBRegistry:
@property
def on_worker_thread_creation() -> Callable[[CBRegistryWorkerThreadCreationEventParams], None]: ...
@on_worker_thread_creation.setter
def on_worker_thread_creation(event_hook: Callable[[CBRegistryWorkerThreadCreationEventParams], None]) -> None: ...

Remarks

This event fires just after a worker thread is created, in the context of that worker thread.

This event is optional; it is provided to give applications a chance to perform additional processing when a new worker thread is created, such as allocating per-thread objects.

The class maintains a pool of worker threads and uses them to fire events; please refer to the Threading and Concurrency topic for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_worker_thread_termination Event

Fires just before a worker thread is terminated.

Syntax

class CBRegistryWorkerThreadTerminationEventParams(object):
# In class CBRegistry:
@property
def on_worker_thread_termination() -> Callable[[CBRegistryWorkerThreadTerminationEventParams], None]: ...
@on_worker_thread_termination.setter
def on_worker_thread_termination(event_hook: Callable[[CBRegistryWorkerThreadTerminationEventParams], None]) -> None: ...

Remarks

This event fires just before a worker thread is terminated, in the context of that worker thread.

This event is optional; it is provided to give applications a chance to perform additional processing before a worker thread is terminated, such as deallocating per-thread objects.

The class maintains a pool of worker threads and uses them to fire events; please refer to the Threading and Concurrency topic for more information.

Any errors that occur during this event are ignored.

This event is fired synchronously; please refer to the Event Types topic for more information.

CBRegistry Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

CBRegistry Config Settings

Base Config Settings

CBRegistry Errors

The class uses Windows error codes during operation as necessary. Please refer to the Error Reporting and Handling topic for more information.

Special Use Errors

	21   ERROR_NOT_READY: Reported by the methods of the class if initialize has not been called or did not succeed.
	575   ERROR_APP_INIT_FAILURE: Reported by the methods of the class if initialize has not been called or did not succeed. Differs from ERROR_NOT_READY (21) in that it indicates a specific situation in the internal code.
	588   ERROR_FS_DRIVER_REQUIRED: Reported if the required system module was not correctly installed for the given ProductGUID.
	614   ERROR_NO_CALLBACK_ACTIVE: Reported by any method that can only be called within event handlers if it is called outside an event handler.
	1292   ERROR_IMPLEMENTATION_LIMIT: Reported when the timeout value provided is less than 3 seconds.
	1314   ERROR_PRIVILEGE_NOT_HELD: Reported by any method that requires elevated permissions if it is called without such permissions.