SetFileAttributes Event

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

Syntax

• C++

ANSI (Cross Platform)
virtual int FireSetFileAttributes(CBFSSetFileAttributesEventParams *e);

typedef struct {
  const char *FileName;
  int64 CreationTime;
  int64 LastAccessTime;
  int64 LastWriteTime;
  int64 ChangeTime;
  int Attributes;
  int64 HandleInfo;
  void *FileContext;
  void *HandleContext;
  int ResultCode;
  int reserved;
} CBFSSetFileAttributesEventParams;

Unicode (Windows)
virtual INT FireSetFileAttributes(CBFSSetFileAttributesEventParams *e);

typedef struct {
  LPCWSTR FileName;
  LONG64 CreationTime;
  LONG64 LastAccessTime;
  LONG64 LastWriteTime;
  LONG64 ChangeTime;
  INT Attributes;
  LONG64 HandleInfo;
  LPVOID FileContext;
  LPVOID HandleContext;
  INT ResultCode;
  INT reserved;
} CBFSSetFileAttributesEventParams;

#define EID_CBFS_SETFILEATTRIBUTES 40

virtual INT CBFSCONNECT_CALL FireSetFileAttributes(LPWSTR &lpszFileName, LONG64 &lCreationTime, LONG64 &lLastAccessTime, LONG64 &lLastWriteTime, LONG64 &lChangeTime, INT &iAttributes, LONG64 &lHandleInfo, LPVOID &lpFileContext, LPVOID &lpHandleContext, INT &iResultCode);

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 0 to indicate that the existing value of the corresponding time must remain unchanged.
  • If the SupportLastAccessTimeAttribute property is disabled, LastAccessTime will always be 0.
  • If the SupportChangeTimeAttribute property is disabled, ChangeTime will always be 0.

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: GetHandleCreatorProcessId, GetHandleCreatorProcessName, GetHandleCreatorThreadId, or GetHandleCreatorToken.

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.