CanFileBeDeleted Event

Fires when the OS needs to know whether a file or directory can be deleted.

Syntax

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

Remarks

This event fires when the OS needs to know whether the file or directory specified by FileName can be deleted.

To handle this event properly, applications must set the CanBeDeleted parameter appropriately. Please note that the firing of this event does not necessarily mean the specified file or directory will be deleted if CanBeDeleted is set to true, just that the OS needs to know whether it can be deleted.

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]