on_after_unlock_single Event

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

Syntax

class CBFilterAfterUnlockSingleEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def offset() -> int: ...
  @property
  def length() -> int: ...
  @property
  def key() -> int: ...
  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...
  @property
  def file_context() -> int: ...
  @file_context.setter
  def file_context(value) -> None: ...
  @property
  def handle_context() -> int: ...
  @handle_context.setter
  def handle_context(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

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