CBFS Connect 2020 Python Edition

Questions / Feedback?

on_get_reparse_point Event

Fires when the OS wants to read a reparse point for a file or directory.


class CBFSGetReparsePointEventParams(object):
  def file_name() -> str: ...
  def reparse_buffer() -> c_void_p: ...
  def reparse_buffer_length() -> int: ...
  def reparse_buffer_length(value) -> None: ...
  def handle_info() -> int: ...
  def file_context() -> int: ...
  def file_context(value) -> None: ...
  def handle_context() -> int: ...
  def handle_context(value) -> None: ...
  def result_code() -> int: ...
  def result_code(value) -> None: ...

# In class CBFS:
def on_get_reparse_point() -> Callable[[CBFSGetReparsePointEventParams], None]: ...
def on_get_reparse_point(event_hook: Callable[[CBFSGetReparsePointEventParams], None]) -> None: ...


This event fires when the OS wants to read a reparse point for the file or directory specified by FileName.

This event only needs to be handled if the use_reparse_points property is enabled. To handle this event properly, applications must populate ReparseBuffer with the reparse point data associated with the specified file or directory (i.e., the data stored during an earlier on_set_reparse_point event), and set ReparseBufferLength to the number of bytes written.

Please refer to the Reparse Points topic for more information.

The ReparseBufferLength parameter's initial value reflects the capacity of the memory buffer pointed to by ReparseBuffer. If the buffer is too small to hold all of the reparse point data, then the application should write as much data to it as possible, set ReparseBufferLength appropriately, and return the ERROR_MORE_DATA error code via ResultCode.

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

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.

Depending on how the request originator accessed the specified file or directory, it may or may not currently be open. The HandleInfo, FileContext, and HandleContext parameters will be absent if it is not open, in which case they 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.

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