on_cleanup_key_context Event

Fires when the application-defined data stored in a registry key context needs 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 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.