NotifyUnlockSingle Event

Fires when a particular locked byte range in a file has been unlocked.

Syntax

• C#
• VB.NET

public event OnNotifyUnlockSingleHandler OnNotifyUnlockSingle;

public delegate void OnNotifyUnlockSingleHandler(object sender, CbfilterNotifyUnlockSingleEventArgs e);

public class CbfilterNotifyUnlockSingleEventArgs : EventArgs {
  public string FileName { get; }
  public long Offset { get; }
  public long Length { get; }
  public long Key { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyUnlockSingle As OnNotifyUnlockSingleHandler

Public Delegate Sub OnNotifyUnlockSingleHandler(sender As Object, e As CbfilterNotifyUnlockSingleEventArgs)

Public Class CbfilterNotifyUnlockSingleEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Offset As Long
  Public ReadOnly Property Length As Long
  Public ReadOnly Property Key As Long
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a particular locked byte range in the file specified by FileName has been unlocked.

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

The Offset, Length, and Key parameters contain the starting byte offset, length, and key values (respectively) specified when the byte range was locked. Please refer to the NotifyLock event's documentation for more information.

The Status parameter contains an NT status code that indicates the outcome of the operation; 0 indicates success. To convert this value to a Win32 error code, call the NtStatusToWin32Error method. Please note that this event won't fire for failed requests unless the ProcessFailedRequests property is enabled.

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, set it to a non-zero value to report an appropriate error. Note, however, that this event fires after the operation has already completed, so reporting an error won't actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

This event is fired asynchronously; please refer to the Event Types topic for more information.