on_before_set_key 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 only need to handle this event if they've added a standard filter rule that includes the 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 that 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've handled the request themselves (this will prevent the corresponding After* event from being called). Note that 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 that, 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 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.