NotifySetFileInfo Event

Fires when information about a file or directory has been changed.

Syntax

ANSI (Cross Platform)
virtual int FireNotifySetFileInfo(CBFilterNotifySetFileInfoEventParams *e);
typedef struct {
const char *FileName;
int FileInformationClass;
const void *Buffer;
int BufferLength;
int ValidBytes;
int Status;
int ResultCode; int reserved; } CBFilterNotifySetFileInfoEventParams; Unicode (Windows) virtual INT FireNotifySetFileInfo(CBFilterNotifySetFileInfoEventParams *e);
typedef struct {
LPCWSTR FileName;
INT FileInformationClass;
LPCVOID Buffer;
INT BufferLength;
INT ValidBytes;
INT Status;
INT ResultCode; INT reserved; } CBFilterNotifySetFileInfoEventParams;
#define EID_CBFILTER_NOTIFYSETFILEINFO 78

virtual INT CBFSFILTER_CALL FireNotifySetFileInfo(LPWSTR &lpszFileName, INT &iFileInformationClass, LPVOID &lpBuffer, INT &iBufferLength, INT &iValidBytes, INT &iStatus, INT &iResultCode);

Remarks

This event fires when information about the file or directory specified by FileName has been changed; typically in response to the Windows API's NtSetInformationFile function.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_NE_QUERY_FILE_INFO flag.

The FileInformationClass parameter indicates what kind of file information was set. Please refer to the NtSetInformationFile function's documentation for more information about possible values.

The Buffer parameter points to a memory buffer that, if the request was successful, contains the new file information. The BufferLength and ValidBytes parameters reflect the capacity of Buffer and the length of the data it contains (respectively), in bytes; ValidBytes may be less than BufferLength. Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The format of the data itself is determined by the specified FileInformationClass; please refer to the NtSetInformationFile function'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 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) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 C++ Edition - Version 20.0 [Build 8317]