CBFS Filter 2020 C++ Builder Edition

Questions / Feedback?

BeforeRenameOrMoveFile Event

Fires before a file or directory is renamed or moved.


typedef struct {
  String FileName;
  String NewFileName;
  bool ReplaceIfExists;
  void* FileContext;
  void* HandleContext;
  bool ProcessRequest;
  int ResultCode;
} TcbfCBFilterBeforeRenameOrMoveFileEventParams;

typedef void __fastcall (__closure *TcbfCBFilterBeforeRenameOrMoveFileEvent)(System::TObject* Sender, TcbfCBFilterBeforeRenameOrMoveFileEventParams *e);

__property TcbfCBFilterBeforeRenameOrMoveFileEvent OnBeforeRenameOrMoveFile = { read=FOnBeforeRenameOrMoveFile, write=FOnBeforeRenameOrMoveFile };


This event fires before the file or directory specified by FileName is renamed or moved to NewFileName.

Applications may use this event to modify the request's parameters, or to block the request entirely. To do the latter, set ProcessRequest to false.

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

The ReplaceIfExists parameter specifies what to do if a file with the specified NewFileName already exists. If this parameter is true, the existing file will be overwritten by the file being renamed/moved; if this parameter is false, the operation will fail. (Note that Windows only allows files to be overwritten; if the destination is an existing directory, the request will be denied regardless of this parameter's value.)

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 ProcessRequest parameter controls whether the request is sent onwards for further processing by subsequent filter drivers and the filesystem; it is true by default.

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.

This event is fired synchronously; please refer to the Event Types topic for more information.

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