CBFS Connect 2020 Python Edition

Questions / Feedback?

on_is_directory_empty Event

Fires when the OS needs to know whether a directory is empty.

Syntax

class CBFSIsDirectoryEmptyEventParams(object):
  @property
  def directory_name() -> str: ...
  @property
  def is_empty() -> bool: ...
  @is_empty.setter
  def is_empty(value) -> None: ...
  @property
  def directory_context() -> int: ...
  @directory_context.setter
  def directory_context(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS needs to know whether the directory specified by DirectoryName is empty.

This event only needs to be handled if the use_directory_empty_check property is enabled. To handle this event properly, applications must set the IsEmpty parameter appropriately.

The DirectoryContext parameter is a placeholder for application-defined data associated with the directory (for "general-purpose" events, it is called FileContext instead). 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]