BeforeCloseKey Event

Fires before a registry key is closed.

Syntax

// CBRegistryBeforeCloseKeyEventArgs carries the CBRegistry BeforeCloseKey event's parameters.
type CBRegistryBeforeCloseKeyEventArgs struct {...}

func (args *CBRegistryBeforeCloseKeyEventArgs) KeyContext() int64
func (args *CBRegistryBeforeCloseKeyEventArgs) StopFiltering() bool
func (args *CBRegistryBeforeCloseKeyEventArgs) SetStopFiltering(value bool)
func (args *CBRegistryBeforeCloseKeyEventArgs) ResultCode() int32
func (args *CBRegistryBeforeCloseKeyEventArgs) SetResultCode(value int32)

// CBRegistryBeforeCloseKeyEvent defines the signature of the CBRegistry BeforeCloseKey event's handler function.
type CBRegistryBeforeCloseKeyEvent func(sender *CBRegistry, args *CBRegistryBeforeCloseKeyEventArgs)

func (obj *CBRegistry) GetOnBeforeCloseKeyHandler() CBRegistryBeforeCloseKeyEvent
func (obj *CBRegistry) SetOnBeforeCloseKeyHandler(handlerFunc CBRegistryBeforeCloseKeyEvent)

Remarks

This event fires before a registry key is closed.

Applications only need to handle this event if they've added a standard filter rule that includes the REG_CE_BEFORE_CLOSE_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 BeforeCreateKey/BeforeOpenKey event so that it can be retrieved when this event fires.

The StopFiltering parameter specifies whether the component'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.