on_notify_unlock_single Event
Fires when a particular locked byte range in a file has been unlocked.
Syntax
class CBMonitorNotifyUnlockSingleEventParams(object): @property def file_name() -> str: ... @property def offset() -> int: ... @property def length() -> int: ... @property def key() -> int: ... @property def status() -> int: ... @property def result_code() -> int: ... @result_code.setter def result_code(value) -> None: ... # In class CBMonitor: @property def on_notify_unlock_single() -> Callable[[CBMonitorNotifyUnlockSingleEventParams], None]: ... @on_notify_unlock_single.setter def on_notify_unlock_single(event_hook: Callable[[CBMonitorNotifyUnlockSingleEventParams], None]) -> None: ...
Remarks
This event fires when a particular locked byte range in the file specified by FileName has 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 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_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.