on_notify_cleanup_file Event

Fires when a file or directory handle has been closed.

Syntax

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

# In class CBMonitor:
@property
def on_notify_cleanup_file() -> Callable[[CBMonitorNotifyCleanupFileEventParams], None]: ...
@on_notify_cleanup_file.setter
def on_notify_cleanup_file(event_hook: Callable[[CBMonitorNotifyCleanupFileEventParams], None]) -> None: ...

Remarks

This event fires when a handle to the file or directory specified by FileName has been closed. This event differs from on_notify_close_file in that on_notify_cleanup_file fires when an open handle to the specified file or directory is closed by a process, whereas on_notify_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_notify_close_file event fires. For example, system components such as the memory manager or cache manager may cause the on_notify_read_file and on_notify_write_file events to fire.

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

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, set it to a non-zero value to report an appropriate error. Note, however, that this event fires after the operation has already completed, so reporting an error won't actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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