on_before_delete_file Event
Fires before a file or directory is deleted.
Syntax
class CBFilterBeforeDeleteFileEventParams(object): @property def file_name() -> str: ... @property def file_context() -> int: ... @file_context.setter def file_context(value) -> None: ... @property def handle_context() -> int: ... @handle_context.setter def handle_context(value) -> None: ... @property def result_code() -> int: ... @result_code.setter def result_code(value) -> None: ... # In class CBFilter: @property def on_before_delete_file() -> Callable[[CBFilterBeforeDeleteFileEventParams], None]: ... @on_before_delete_file.setter def on_before_delete_file(event_hook: Callable[[CBFilterBeforeDeleteFileEventParams], None]) -> None: ...
Remarks
This event fires before the file or directory specified by FileName is deleted. More specifically, this event is fired before the final IRM_MJ_CLOSE IRP is processed by the filesystem.
Applications may use this event to obtain information about the specified file or directory, which still exists at the time this event fires. This event cannot be used to prevent a deletion; use the on_before_can_file_be_deleted event instead.
Note: This event is not fired when a virtual file is deleted; please refer to the Virtual Files topic for more information.
Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_BEFORE_DELETE flag.
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.
This event is fired synchronously; please refer to the Event Types topic for more information.