on_after_create_hard_link Event

Fires after a hard link is created.

Syntax

class CBFilterAfterCreateHardLinkEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def link_name() -> str: ...
  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...
  @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 CBFilter:
@property
def on_after_create_hard_link() -> Callable[[CBFilterAfterCreateHardLinkEventParams], None]: ...
@on_after_create_hard_link.setter
def on_after_create_hard_link(event_hook: Callable[[CBFilterAfterCreateHardLinkEventParams], None]) -> None: ...

Remarks

This event fires after a hard link to the file specified by FileName is created. Please refer to Microsoft's Hard Links article for more information about hard links.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_AFTER_CREATE_HARD_LINK flag.

The LinkName parameter reflects the name of the created hard link.

The Status parameter contains an NT status code that indicates the outcome of the operation; 0 indicates success. To convert this value to a Win32 error code, call the nt_status_to_win_32_error method. Please note that this event won't fire for failed requests unless the process_failed_requests property is enabled. Applications may change this parameter's value if they want a different NT status code to be returned.

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.

This event is fired synchronously; please refer to the Event Types topic for more information.