CBFS Connect 2020 Python Edition

Questions / Feedback?

on_delete_file Event

Fires when the OS needs to delete a file or directory.

Syntax

class CBFSDeleteFileEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def file_context() -> int: ...
  @file_context.setter
  def file_context(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFS:
@property
def on_delete_file() -> Callable[[CBFSDeleteFileEventParams], None]: ...
@on_delete_file.setter
def on_delete_file(event_hook: Callable[[CBFSDeleteFileEventParams], None]) -> None: ...

Remarks

This event fires when the OS has decided to delete the file or directory specified by FileName.

To handle this event properly, applications must perform any actions needed to delete the specified file or directory from their backend storage. If the use_hard_links property is enabled, a file's data should only be deleted when its last hard link is deleted; please refer to the Hard Links topic for more information.

Important:

  • A deletion cannot be cancelled from this event; applications that wish to prevent a deletion must do so via the on_can_file_be_deleted event.
  • This event fires immediately after the last on_close_file event. If the application disposes of the FileContext in the on_close_file event handler, it will be invalid when this event fires. The on_close_file event includes a DeleteFile parameter that helps address this situation.

The FileContext parameter is a placeholder for application-defined data associated with the file. 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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Python Edition - Version 20.0 [Build 7880]