on_read_file Event

Fires when the OS needs to read data from an open file.

Syntax

class CBFSReadFileEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def position() -> int: ...
  @property
  def buffer() -> c_void_p: ...
  @property
  def bytes_to_read() -> int: ...
  @property
  def bytes_read() -> int: ...
  @bytes_read.setter
  def bytes_read(value) -> None: ...
  @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 result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS needs to read data from the already-open file specified by FileName.

To handle this event properly, applications should read BytesToRead bytes of data from the specified file into the memory region pointed to by Buffer. Reading must begin at the specified Position in the file, and when reading is complete, applications must set BytesRead to reflect the actual number of bytes copied into Buffer. Applications must not attempt to copy more than BytesToRead bytes of data into Buffer.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

Note: While it is technically possible for an application to return fewer than BytesToRead bytes of data, doing so is abnormal, and should be avoided. Most processes treat read requests as "all or nothing", so returning less data than requested is likely to cause an ungraceful failure.

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. (This parameter may be absent, in which case it will be 0.)

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. (HandleContext may be absent, in which case it will be None.)

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.