on_after_cleanup_file Event

Fires after a file or directory handle is closed.

Syntax

class CBFilterAfterCleanupFileEventParams(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_after_cleanup_file() -> Callable[[CBFilterAfterCleanupFileEventParams], None]: ...
@on_after_cleanup_file.setter
def on_after_cleanup_file(event_hook: Callable[[CBFilterAfterCleanupFileEventParams], None]) -> None: ...

Remarks

This event fires after a handle to the file or directory specified by FileName is closed. This event differs from on_after_close_file in that on_after_cleanup_file fires immediately after an open handle to the specified file or directory is closed by a process, whereas on_after_close_file may be fired much later when the OS itself decides that the file or directory can be formally closed.

Other events may fire for the file or directory in the time between when this event fires and when the on_after_close_file event fires. For example, system components such as the memory manager or cache manager may cause the on_after_read_file and on_after_write_file events to fire.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_AFTER_CLEANUP 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.