CBFS Filter 2020 Python Edition

Questions / Feedback?

on_after_rename_or_move_file Event

Fires after a file or directory is renamed or moved.

Syntax

class CBFilterAfterRenameOrMoveFileEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def new_file_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_rename_or_move_file() -> Callable[[CBFilterAfterRenameOrMoveFileEventParams], None]: ...
@on_after_rename_or_move_file.setter
def on_after_rename_or_move_file(event_hook: Callable[[CBFilterAfterRenameOrMoveFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is renamed or moved to NewFileName.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_AFTER_RENAME flag. A rule's mask is matched against both previous and new filenames and the event will fire when either of the names matches the mask.

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.

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