on_notify_read_file Event
Fires when data has been read from a file.
Syntax
class CBMonitorNotifyReadFileEventParams(object): @property def file_name() -> str: ... @property def position() -> int: ... @property def bytes_to_read() -> int: ... @property def direction() -> int: ... @property def bytes_read() -> 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_read_file() -> Callable[[CBMonitorNotifyReadFileEventParams], None]: ... @on_notify_read_file.setter def on_notify_read_file(event_hook: Callable[[CBMonitorNotifyReadFileEventParams], None]) -> None: ...
Remarks
This event fires when data has been read from the file specified by FileName.
Applications only need to handle this event if they've added a standard filter rule that includes the FS_NE_READ flag.
The Position parameter reflects the byte offset in the file at which reading started.
The BytesToRead parameter reflects how many bytes were to be read from the file.
The Direction parameter indicates the request direction; please refer to the Cached and Non-Cached Requests topic for more information. Possible values are:
| FS_REQUEST_DIR_USER_NONCACHED | 0 | Operations performed in the 'user mode application <--> filesystem' direction. |
| FS_REQUEST_DIR_USER_CACHED | 1 | Operations performed in the 'user mode application <--> system cache' direction. |
| FS_REQUEST_DIR_SYSTEM_NONCACHED | 2 | Operations performed in the 'system cache <--> filesystem' direction. |
| FS_REQUEST_DIR_SYSTEM_CACHED | 3 | Operations performed in the 'system component <--> system cache' direction. |
The BytesRead parameter reflects how many bytes were actually read from the file.
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.