CloseKeyHandle Event

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

Syntax

• C#
• VB.NET

public event OnCloseKeyHandleHandler OnCloseKeyHandle;

public delegate void OnCloseKeyHandleHandler(object sender, CbregistryCloseKeyHandleEventArgs e);

public class CbregistryCloseKeyHandleEventArgs : EventArgs {
  public IntPtr KeyContext { get; }
  public long KeyHandle { get; }
  public IntPtr KeyHandleContext { get; }
  public int Error { get; }
  public bool Processed { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnCloseKeyHandle As OnCloseKeyHandleHandler

Public Delegate Sub OnCloseKeyHandleHandler(sender As Object, e As CbregistryCloseKeyHandleEventArgs)

Public Class CbregistryCloseKeyHandleEventArgs Inherits EventArgs
  Public ReadOnly Property KeyContext As IntPtr
  Public ReadOnly Property KeyHandle As Long
  Public ReadOnly Property KeyHandleContext As IntPtr
  Public ReadOnly Property Error As Integer
  Public Property Processed As Boolean
  Public Property ResultCode As Integer
End Class

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.