CBFS Connect 2020 Python Edition

Questions / Feedback?

on_set_file_attributes Event

Fires when the OS needs to change the attributes of an open file or directory.

Syntax

class CBFSSetFileAttributesEventParams(object):
  @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 attributes() -> int: ...
  @property
  def handle_info() -> int: ...
  @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 CBFS:
@property
def on_set_file_attributes() -> Callable[[CBFSSetFileAttributesEventParams], None]: ...
@on_set_file_attributes.setter
def on_set_file_attributes(event_hook: Callable[[CBFSSetFileAttributesEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to change the attributes of the already-open file or directory specified by FileName.

To handle this event properly, applications must update the attributes of the specified file or directory in their backend storage using the following parameters:

  • Attributes: the new attributes of the file or directory, or 0 to indicate that the existing attributes must remain unchanged.
    • The FILE_ATTRIBUTE_NORMAL attribute is only valid when used alone, it "resets" a file's attributes.
    • Please refer to Microsoft's File Attribute Constants article for attribute descriptions.
  • CreationTime, LastAccessTime, LastWriteTime, ChangeTime: the new time values for the file or directory, any of which may be January 1, 1970 00:00:00 UTC to indicate that the existing value of the corresponding time must remain unchanged.

The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: get_handle_creator_process_id, get_handle_creator_process_name, get_handle_creator_thread_id, or get_handle_creator_token.

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.

 
 
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Python Edition - Version 20.0 [Build 7880]