CBFS Filter 2020 Python Edition

Questions / Feedback?

on_before_set_file_size Event

Fires before a file is resized.

Syntax

class CBFilterBeforeSetFileSizeEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def size() -> int: ...
  @size.setter
  def size(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 process_request() -> bool: ...
  @process_request.setter
  def process_request(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires before the file specified by FileName is resized, whether explicitly (e.g., truncation) or implicitly (i.e., as data is appended).

Applications may use this event to modify the request's parameters.

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

The Size parameter specifies the new file size, in bytes.

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. (If the system's cache manager or memory manager initiated the operation, HandleContext may be absent, in which case it will be None.)

The ProcessRequest parameter controls whether the request is sent onwards for further processing by subsequent filter drivers and the filesystem; it is True by default.

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]