NotifyReadFile Event

Fires when data has been read from a file.

Syntax

virtual int FireNotifyReadFile(CBFilterNotifyReadFileEventParams *e);
typedef struct {
const char *FileName;
int64 Position;
int BytesToRead;
int Direction;
int BytesRead;
int Status;
int ResultCode; int reserved; } CBFilterNotifyReadFileEventParams;
virtual INT FireNotifyReadFile(CBFilterNotifyReadFileEventParams *e);
typedef struct {
LPCWSTR FileName;
LONG64 Position;
INT BytesToRead;
INT Direction;
INT BytesRead;
INT Status;
INT ResultCode; INT reserved; } CBFilterNotifyReadFileEventParams;

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_NONCACHED0Operations performed in the 'user mode application <--> filesystem' direction.
FS_REQUEST_DIR_USER_CACHED1Operations performed in the 'user mode application <--> system cache' direction.
FS_REQUEST_DIR_SYSTEM_NONCACHED2Operations performed in the 'system cache <--> filesystem' direction.
FS_REQUEST_DIR_SYSTEM_CACHED3Operations 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.

 
 
Copyright (c) 2020 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 C++ Edition - Version 20.0 [Build 7543]