BeforeSetKey Event
Fires before a registry key's information is updated.
Syntax
public event OnBeforeSetKeyHandler OnBeforeSetKey; public delegate void OnBeforeSetKeyHandler(object sender, CbregistryBeforeSetKeyEventArgs e); public class CbregistryBeforeSetKeyEventArgs : EventArgs { public IntPtr KeyContext { get; } public DateTime LastWriteTime { get; } public bool Processed { get; set; } public bool FireAfterEvent { get; set; } public bool StopFiltering { get; set; } public int ResultCode { get; set; } }
Public Event OnBeforeSetKey As OnBeforeSetKeyHandler Public Delegate Sub OnBeforeSetKeyHandler(sender As Object, e As CbregistryBeforeSetKeyEventArgs) Public Class CbregistryBeforeSetKeyEventArgs Inherits EventArgs Public ReadOnly Property KeyContext As IntPtr Public ReadOnly Property LastWriteTime As DateTime Public Property Processed As Boolean Public Property FireAfterEvent As Boolean Public Property StopFiltering As Boolean Public Property ResultCode As Integer End Class
Remarks
This event fires before a registry key's information is updated.
Applications only need to handle this event if they've added a standard filter rule that includes the REG_CE_BEFORE_SET_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 LastWriteTime parameter reflects when the key was last changed, specified in UTC.
The Processed parameter indicates whether the underlying request has been handled successfully. Applications should set this parameter to true if they've handled the request themselves (this will prevent the corresponding After* event from being called). Note that this parameter's value is ignored if an error is returned via ResultCode.
The FireAfterEvent parameter specifies whether the corresponding After* event should be fired; it is true by default. Note that, regardless of how this parameter is set, the corresponding After* event will not fire if Processed is true, or if an error code is returned via ResultCode.
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.