on_notify_lock Event

Fires when a range of bytes in a file has been locked.

Syntax

class CBMonitorNotifyLockEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def offset() -> int: ...
  @property
  def length() -> int: ...
  @property
  def key() -> int: ...
  @property
  def fail_immediately() -> bool: ...
  @property
  def exclusive_lock() -> bool: ...
  @property
  def status() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBMonitor:
@property
def on_notify_lock() -> Callable[[CBMonitorNotifyLockEventParams], None]: ...
@on_notify_lock.setter
def on_notify_lock(event_hook: Callable[[CBMonitorNotifyLockEventParams], None]) -> None: ...

Remarks

This event fires when a range of bytes in the file specified by FileName has been 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_NE_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 nt_status_to_win_32_error method. Please note that this event won't fire for failed requests unless the process_failed_requests 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.