CBFS Connect 2020 Python Edition

Questions / Feedback?

on_close_hard_links_enumeration Event

Fires when the OS is finished enumerating a file's hard links.

Syntax

class CBFSCloseHardLinksEnumerationEventParams(object):
  @property
  def file_name() -> str: ...
  @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 enumeration_context() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS is finished enumerating the hard links of the file specified by FileName.

This event only needs to be handled if the use_hard_links property is enabled. To handle this event properly, applications must release any resources that were allocated for/by the hard link enumeration in earlier on_enumerate_hard_links events.

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, HandleContext, and EnumerationContext parameters are placeholders for application-defined data associated with the file, specific handle, and enumeration; 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]