CBFS Filter 2020 Python Edition

Questions / Feedback?

on_notify_can_file_be_deleted Event

Fires when the OS marks a file or directory for deletion or removes such a mark.

Syntax

class CBMonitorNotifyCanFileBeDeletedEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def can_delete() -> bool: ...
  @property
  def status() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS marks the file or directory specified by FileName for deletion or removes such a mark.

Files and directories can be deleted in two ways: a file or directory can be opened with the FILE_FLAG_DELETE_ON_CLOSE flag, or some process may call Windows API's NtSetInformationFile function with FILE_DISPOSITION_INFORMATION or FILE_DISPOSITION_INFORMATION_EX structure as a parameter.

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

The CanDelete parameter reflects whether the file or directory can be deleted.

The Status parameter contains an NT status code that indicates the outcome of the operation; 0 indicates success. To convert this value to a Win32 error code, call the nt_status_to_win_32_error method. Please note that this event won't fire for failed requests unless the process_failed_requests property is enabled.

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.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 8317]