BeforeUnlockAllByKey Event

Fires before all locked byte ranges in a file, associated with a particular key, are unlocked.

Syntax

• C#
• VB.NET

public event OnBeforeUnlockAllByKeyHandler OnBeforeUnlockAllByKey;

public delegate void OnBeforeUnlockAllByKeyHandler(object sender, CbfilterBeforeUnlockAllByKeyEventArgs e);

public class CbfilterBeforeUnlockAllByKeyEventArgs : EventArgs {
  public string FileName { get; }
  public long Key { get; }
  public IntPtr FileContext { get; set; }
  public IntPtr HandleContext { get; set; }
  public bool ProcessRequest { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnBeforeUnlockAllByKey As OnBeforeUnlockAllByKeyHandler

Public Delegate Sub OnBeforeUnlockAllByKeyHandler(sender As Object, e As CbfilterBeforeUnlockAllByKeyEventArgs)

Public Class CbfilterBeforeUnlockAllByKeyEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Key As Long
  Public Property FileContext As IntPtr
  Public Property HandleContext As IntPtr
  Public Property ProcessRequest As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires before all locked byte ranges in the file specified by FileName, and associated with the specified Key, are unlocked.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_BEFORE_LOCK_CONTROL flag.

The Key parameter contains the key value specified when the byte ranges were locked. Please refer to the BeforeLock event's documentation for more information.

The FileContext and HandleContext parameters are placeholders for application-defined data associated with the file and specific handle, respectively. Please refer to the Contexts topic for more information.

The ProcessRequest parameter controls whether the request is sent onwards for further processing by subsequent filter drivers and the filesystem; it is true by default.

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.