Fires when the OS needs to know whether a file or directory can be deleted.
class CBFSCanFileBeDeletedEventParams(object): @property def file_name() -> str: ... @property def handle_info() -> int: ... @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 can_be_deleted() -> bool: ... @can_be_deleted.setter def can_be_deleted(value) -> None: ... @property def result_code() -> int: ... @result_code.setter def result_code(value) -> None: ... # In class CBFS: @property def on_can_file_be_deleted() -> Callable[[CBFSCanFileBeDeletedEventParams], None]: ... @on_can_file_be_deleted.setter def on_can_file_be_deleted(event_hook: Callable[[CBFSCanFileBeDeletedEventParams], None]) -> None: ...
This event fires when the OS needs to know whether the file or directory specified by FileName can be deleted.
To handle this event properly, applications must set the CanBeDeleted parameter appropriately. Please note that the firing of this event does not necessarily mean the specified file or directory will be deleted if CanBeDeleted is set to True, just that the OS needs to know whether it can be deleted.
The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: get_handle_creator_process_id, get_handle_creator_process_name, get_handle_creator_thread_id, or get_handle_creator_token.
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.