NotifyCleanupFile Event

Fires when a file or directory handle has been closed.

Syntax

ANSI (Cross Platform)
virtual int FireNotifyCleanupFile(CBFilterNotifyCleanupFileEventParams *e);
typedef struct {
const char *FileName;
int ResultCode; int reserved; } CBFilterNotifyCleanupFileEventParams; Unicode (Windows) virtual INT FireNotifyCleanupFile(CBFilterNotifyCleanupFileEventParams *e);
typedef struct {
LPCWSTR FileName;
INT ResultCode; INT reserved; } CBFilterNotifyCleanupFileEventParams;
#define EID_CBFILTER_NOTIFYCLEANUPFILE 59

virtual INT CBFSFILTER_CALL FireNotifyCleanupFile(LPWSTR &lpszFileName, INT &iResultCode);

Remarks

This event fires when a handle to the file or directory specified by FileName has been closed. This event differs from NotifyCloseFile in that NotifyCleanupFile fires when an open handle to the specified file or directory is closed by a process, whereas NotifyCloseFile may be fired much later when the OS itself decides that the file or directory can be formally closed.

Other events may fire for the file or directory in the time between when this event fires and when the NotifyCloseFile event fires. For example, system components such as the memory manager or cache manager may cause the NotifyReadFile and NotifyWriteFile events to fire.

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

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]