NotifyReadFile Event
Fires when data has been read from a file.
Syntax
public event OnNotifyReadFileHandler OnNotifyReadFile; public delegate void OnNotifyReadFileHandler(object sender, CbfilterNotifyReadFileEventArgs e); public class CbfilterNotifyReadFileEventArgs : EventArgs { public string FileName { get; } public long Position { get; } public int BytesToRead { get; } public int Direction { get; } public int BytesRead { get; } public int Status { get; } public int ResultCode { get; set; } }
Public Event OnNotifyReadFile As OnNotifyReadFileHandler Public Delegate Sub OnNotifyReadFileHandler(sender As Object, e As CbfilterNotifyReadFileEventArgs) Public Class CbfilterNotifyReadFileEventArgs Inherits EventArgs Public ReadOnly Property FileName As String Public ReadOnly Property Position As Long Public ReadOnly Property BytesToRead As Integer Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesRead As Integer Public ReadOnly Property Status As Integer Public Property ResultCode As Integer End Class
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 NtStatusToWin32Error method. Please note that this event won't fire for failed requests unless the ProcessFailedRequests 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.