CleanupKeyContext Event

Fires when the application-defined data stored in a registry key context needs be cleaned up.

Syntax

// CBRegistryCleanupKeyContextEventArgs carries the CBRegistry CleanupKeyContext event's parameters.
type CBRegistryCleanupKeyContextEventArgs struct {...}

func (args *CBRegistryCleanupKeyContextEventArgs) KeyContext() int64
func (args *CBRegistryCleanupKeyContextEventArgs) ResultCode() int32
func (args *CBRegistryCleanupKeyContextEventArgs) SetResultCode(value int32)

// CBRegistryCleanupKeyContextEvent defines the signature of the CBRegistry CleanupKeyContext event's handler function.
type CBRegistryCleanupKeyContextEvent func(sender *CBRegistry, args *CBRegistryCleanupKeyContextEventArgs)

func (obj *CBRegistry) GetOnCleanupKeyContextHandler() CBRegistryCleanupKeyContextEvent
func (obj *CBRegistry) SetOnCleanupKeyContextHandler(handlerFunc CBRegistryCleanupKeyContextEvent)

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.