AfterUnlockSingle Event

Fires after a particular locked byte range in a file is unlocked.

Syntax

• C#
• VB.NET

public event OnAfterUnlockSingleHandler OnAfterUnlockSingle;

public delegate void OnAfterUnlockSingleHandler(object sender, CbfilterAfterUnlockSingleEventArgs e);

public class CbfilterAfterUnlockSingleEventArgs : EventArgs {
  public string FileName { get; }
  public long Offset { get; }
  public long Length { get; }
  public long Key { get; }
  public int Status { get; set; }
  public IntPtr FileContext { get; set; }
  public IntPtr HandleContext { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnAfterUnlockSingle As OnAfterUnlockSingleHandler

Public Delegate Sub OnAfterUnlockSingleHandler(sender As Object, e As CbfilterAfterUnlockSingleEventArgs)

Public Class CbfilterAfterUnlockSingleEventArgs 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 Property Status As Integer
  Public Property FileContext As IntPtr
  Public Property HandleContext As IntPtr
  Public Property ResultCode As Integer
End Class

Remarks

This event fires after a particular locked byte range in the file specified by FileName is unlocked.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_AFTER_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 AfterLock 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. Applications may change this parameter's value if they want a different NT status code to be returned.

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.