CBFS Connect 2020 Python Edition

Questions / Feedback?

on_create_hard_link Event

Fires when the OS wants to create a new hard link to an existing file.


class CBFSCreateHardLinkEventParams(object):
  def file_name() -> str: ...
  def link_name() -> str: ...
  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_create_hard_link() -> Callable[[CBFSCreateHardLinkEventParams], None]: ...
def on_create_hard_link(event_hook: Callable[[CBFSCreateHardLinkEventParams], None]) -> None: ...


This event fires when the OS wants to create a new hard link that points to the existing file specified by FileName. The LinkName parameter specifies the absolute path (including filename) of the link to be created.

This event only needs to be handled if the use_hard_links property is enabled. To handle this event properly, applications should perform any actions needed to create an additional hard link to the specified file in their backend storage.

Please refer to the Hard Links topic for more information.

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.

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