CBFS Connect 2020 Python Edition

Questions / Feedback?

on_close_file Event

Fires when the OS needs to close a file.

Syntax

class CBFSCloseFileEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def delete_file() -> bool: ...
  @property
  def handle_info() -> int: ...
  @property
  def file_context() -> int: ...
  @property
  def handle_context() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS needs to close the file specified by FileName. If the fire_all_open_close_events property is disabled, this event will only fire after the last handle to the specified file is closed.

To handle this event properly, applications can (if necessary/applicable) check to see if there are any other handles open for the file, and if not, close whatever backend resources are currently open for it.

The DeleteFile parameter indicates whether the file should be deleted; if it's True, the on_delete_file event will fire immediately after this event. The application may delete the file from either event handler.

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.

Note: The OS sends a file close request asynchronously, later than a process closes its handle(s) to the opened file. Due to this, the result code returned by the event handler does not get back to the process that closed the file handle.

 
 
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Python Edition - Version 20.0 [Build 7880]