CloseFile Event

Fires when the OS needs to close a file.

Syntax

virtual int FireCloseFile(CBFSCloseFileEventParams *e);
typedef struct {
const char *FileName;
int DeleteFile;
int64 HandleInfo;
void *FileContext;
void *HandleContext;
int ResultCode; int reserved; } CBFSCloseFileEventParams;
virtual INT FireCloseFile(CBFSCloseFileEventParams *e);
typedef struct {
LPCWSTR FileName;
BOOL DeleteFile;
LONG64 HandleInfo;
LPVOID FileContext;
LPVOID HandleContext;
INT ResultCode; INT reserved; } CBFSCloseFileEventParams;

Remarks

This event fires when the OS needs to close the file specified by FileName. If the FireAllOpenCloseEvents property is disabled, this event will only fire after the last handle to the specified file is closed.

To handle this event properly, applications can (if necessary/applicable) check to see if there are any other handles open for the file, and if not, close whatever backend resources are currently open for it.

The DeleteFile parameter indicates whether the file should be deleted; if it's true, the DeleteFile event will fire immediately after this event. The application may delete the file from either event handler.

The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: GetHandleCreatorProcessId, GetHandleCreatorProcessName, GetHandleCreatorThreadId, or GetHandleCreatorToken.

The FileContext and HandleContext parameters are placeholders for application-defined data associated with the file and specific handle, respectively. Please refer to the Contexts topic for more information.

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 (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

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