on_close_directory_enumeration Event

Fires when the OS is finished enumerating a directory's contents.

Syntax

class CBFSCloseDirectoryEnumerationEventParams(object):
  @property
  def directory_name() -> str: ...
  @property
  def directory_context() -> int: ...
  @directory_context.setter
  def directory_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_directory_enumeration() -> Callable[[CBFSCloseDirectoryEnumerationEventParams], None]: ...
@on_close_directory_enumeration.setter
def on_close_directory_enumeration(event_hook: Callable[[CBFSCloseDirectoryEnumerationEventParams], None]) -> None: ...

Remarks

This event fires when the OS is finished enumerating the contents of the directory specified by DirectoryName.

To handle this event properly, applications must release any resources that were allocated for/by the directory enumeration in earlier on_enumerate_directory events.

The DirectoryContext and EnumerationContext parameters are placeholders for application-defined data associated with the directory and enumeration, respectively. Please refer to the Contexts topic for more information about them.

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.