on_notify_unlock_all_by_key Event

Fires when all locked byte ranges in a file, associated with a particular key, have been unlocked.

Syntax

class CBFilterNotifyUnlockAllByKeyEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def key() -> int: ...
  @property
  def status() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_notify_unlock_all_by_key() -> Callable[[CBFilterNotifyUnlockAllByKeyEventParams], None]: ...
@on_notify_unlock_all_by_key.setter
def on_notify_unlock_all_by_key(event_hook: Callable[[CBFilterNotifyUnlockAllByKeyEventParams], None]) -> None: ...

Remarks

This event fires when all locked byte ranges in the file specified by FileName, and associated with the specified Key, have 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 Key parameter contains the key value specified when the byte ranges were locked. Please refer to the on_notify_lock 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 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.