on_after_get_file_sizes Event

Fires after a file's size information is retrieved.

Syntax

class CBFilterAfterGetFileSizesEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def size() -> int: ...
  @size.setter
  def size(value) -> None: ...
  @property
  def allocation_size() -> int: ...
  @allocation_size.setter
  def allocation_size(value) -> None: ...
  @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_get_file_sizes() -> Callable[[CBFilterAfterGetFileSizesEventParams], None]: ...
@on_after_get_file_sizes.setter
def on_after_get_file_sizes(event_hook: Callable[[CBFilterAfterGetFileSizesEventParams], None]) -> None: ...

Remarks

This event fires after size information is retrieved for the file specified by FileName.

Applications that intend to modify a file's contents should use this event to modify the file's actual size and/or allocation size as necessary. Applications that make use of virtual files should use this event to report virtual files' sizes.

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

The Size parameter specifies the actual size of the file, in bytes.

The AllocationSize parameter specifies the amount of space allocated for the file, in bytes.

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.