on_before_set_file_attributes Event

Fires before a file or directory's attributes and/or times are changed.

Syntax

class CBFilterBeforeSetFileAttributesEventParams(object):
  @property
  def file_name() -> str: ...
  @property
  def creation_time() -> datetime.datetime: ...
  @creation_time.setter
  def creation_time(value) -> None: ...
  @property
  def last_access_time() -> datetime.datetime: ...
  @last_access_time.setter
  def last_access_time(value) -> None: ...
  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...
  @property
  def change_time() -> datetime.datetime: ...
  @change_time.setter
  def change_time(value) -> None: ...
  @property
  def attributes() -> int: ...
  @attributes.setter
  def attributes(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_attributes() -> Callable[[CBFilterBeforeSetFileAttributesEventParams], None]: ...
@on_before_set_file_attributes.setter
def on_before_set_file_attributes(event_hook: Callable[[CBFilterBeforeSetFileAttributesEventParams], None]) -> None: ...

Remarks

This event fires before the attributes and/or times of the file or directory specified by FileName are changed.

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_ATTRIBUTES flag.

The CreationTime, LastAccessTime, LastWriteTime, and ChangeTime parameters specify the new time values, specified in UTC. A value of January 1, 1970 00:00:00 UTC indicates that the corresponding time value is not included in the request.

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

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 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.