on_set_reparse_point Event

Fires when the OS wants to create or update a reparse point on a file or directory.

Syntax

class CBFSSetReparsePointEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def reparse_tag() -> int: ...
  @property
  def reparse_buffer() -> c_void_p: ...
  @property
  def reparse_buffer_length() -> int: ...
  @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_set_reparse_point() -> Callable[[CBFSSetReparsePointEventParams], None]: ...
@on_set_reparse_point.setter
def on_set_reparse_point(event_hook: Callable[[CBFSSetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to create or update a reparse point on the file or directory specified by FileName.

This event only needs to be handled if the use_reparse_points property is enabled.
Note: NFS sharing makes use of reparse points.

To handle this event properly, applications must store the given reparse point data and tag, and associate them with the specified file or directory, in their backend storage. Both pieces of information are needed for the application to correctly handle any future on_get_file_info and on_enumerate_directory events concerning the specified file or directory.

Please refer to the Reparse Points topic for more information.

The ReparseTag parameter specifies the reparse point's tag, which is the value the system uses to identify the format of the reparse point data. This value is also present in the ReparseBuffer data; the class extracts it and provides it separately for convenience.

The ReparseBuffer parameter points to a memory buffer that contains the full reparse point data. The ReparseBufferLength parameter specifies the length, in bytes, of ReparseBuffer.

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.

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.