AfterLock Event

Fires after a range of bytes in a file is locked.

Syntax

public class DefaultCbfilterEventListener implements CbfilterEventListener {
  ...
  public void afterLock(CbfilterAfterLockEvent e) {}
  ...
}

public class CbfilterAfterLockEvent {
  public String fileName;
  public long offset;
  public long length;
  public long key;
  public boolean failImmediately;
  public boolean exclusiveLock;
  public int status;
  public long fileContext;
  public long handleContext;
  public int resultCode;
}

Remarks

This event fires after a range of bytes in the file specified by FileName is locked; either by the OS, or on behalf of a user mode application that called the Windows API's LockFile or LockFileEx function.

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 parameter reflects the byte offset where the byte range lock starts.

The Length parameter reflects the length of the byte range lock.

The Key parameter reflects the key that the byte range lock is associated with. This key is used to identify the byte range lock in later unlock-by-key requests.

The FailImmediately parameter indicates whether the request was to fail if the lock could not be granted immediately.

The ExclusiveLock parameter indicates whether the byte range lock was to be exclusive (true) or shared (false).

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 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 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.