CBFS Filter 2020 Python Edition

Questions / Feedback?

on_after_rename_key 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 only need to handle this event if they've added a standard filter rule that includes the 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 that 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 alter any of the parameters related to the response values. Note that 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 isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

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

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 8317]