CloseKeyHandle Event

Fires when an application-provided registry key handle should be closed.

Syntax

// CBRegistryCloseKeyHandleEventArgs carries the CBRegistry CloseKeyHandle event's parameters.
type CBRegistryCloseKeyHandleEventArgs struct {...}

func (args *CBRegistryCloseKeyHandleEventArgs) KeyContext() int64
func (args *CBRegistryCloseKeyHandleEventArgs) KeyHandle() int64
func (args *CBRegistryCloseKeyHandleEventArgs) KeyHandleContext() int64
func (args *CBRegistryCloseKeyHandleEventArgs) Error() int32
func (args *CBRegistryCloseKeyHandleEventArgs) Processed() bool
func (args *CBRegistryCloseKeyHandleEventArgs) SetProcessed(value bool)
func (args *CBRegistryCloseKeyHandleEventArgs) ResultCode() int32
func (args *CBRegistryCloseKeyHandleEventArgs) SetResultCode(value int32)

// CBRegistryCloseKeyHandleEvent defines the signature of the CBRegistry CloseKeyHandle event's handler function.
type CBRegistryCloseKeyHandleEvent func(sender *CBRegistry, args *CBRegistryCloseKeyHandleEventArgs)

func (obj *CBRegistry) GetOnCloseKeyHandleHandler() CBRegistryCloseKeyHandleEvent
func (obj *CBRegistry) SetOnCloseKeyHandleHandler(handlerFunc CBRegistryCloseKeyHandleEvent)

Remarks

This event fires when the application-provided registry key handle, specified by KeyHandle, should be closed; and the associated KeyHandleContext 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 component will close 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 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 Go Edition - Version 20.0 [Build 8124]