CBFS Filter 2020 Node.js Edition

Questions / Feedback?

CloseKeyHandle Event

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

Syntax

cbregistry.on('CloseKeyHandle', [callback])

Callback

The 'callback' is called when the 'CloseKeyHandle' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.keyContext
e.keyHandle
e.keyHandleContext
e.error
e.processed
e.resultCode

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 class 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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 7917]