CBFS Filter 2020 Python Edition

Questions / Feedback?

on_notify_enumerate_directory Event

Fires when a directory entry has been returned during directory enumeration.

Syntax

class CBFilterNotifyEnumerateDirectoryEventParams(object):
  @property
  def directory_name() -> str: ...
  @property
  def file_name() -> str: ...
  @property
  def creation_time() -> datetime.datetime: ...
  @property
  def last_access_time() -> datetime.datetime: ...
  @property
  def last_write_time() -> datetime.datetime: ...
  @property
  def change_time() -> datetime.datetime: ...
  @property
  def size() -> int: ...
  @property
  def allocation_size() -> int: ...
  @property
  def file_id() -> int: ...
  @property
  def attributes() -> int: ...
  @property
  def status() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_notify_enumerate_directory() -> Callable[[CBFilterNotifyEnumerateDirectoryEventParams], None]: ...
@on_notify_enumerate_directory.setter
def on_notify_enumerate_directory(event_hook: Callable[[CBFilterNotifyEnumerateDirectoryEventParams], None]) -> None: ...

Remarks

This event fires when a directory entry (i.e., file or subdirectory) has been returned during enumeration of the directory specified by DirectoryName.

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

The FileName parameter reflects the name of the directory entry.

The CreationTime, LastAccessTime, LastWriteTime, and ChangeTime parameters reflect the entry's time values, specified in UTC.

The Size parameter reflects the size of the file, in bytes; it is always 0 for subdirectories.

The AllocationSize parameter reflects the amount of space allocated for the file, in bytes; it is always 0 for subdirectories.

The FileId parameter reflects the unique Id of the entry, as reported by the filesystem. This Id is used by the network redirector, and some third-party applications, to open files and directories by Id instead of by name. The root directory always uses the predefined Id 0x7FFFFFFFFFFFFFFF.

The Attributes parameter reflects the entry's attributes; please refer to Microsoft's File Attribute Constants article for attribute descriptions.

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.

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, set it to a non-zero value to report an appropriate error. Note, however, that this event fires after the operation has already completed, so reporting an error won't actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 8317]