CBFS Connect 2020 .NET Edition

Questions / Feedback?

SetFileAttributes Event

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

Syntax

public event OnSetFileAttributesHandler OnSetFileAttributes;

public delegate void OnSetFileAttributesHandler(object sender, CbfsSetFileAttributesEventArgs e);

public class CbfsSetFileAttributesEventArgs : EventArgs {
  public string FileName { get; }
  public DateTime CreationTime { get; }
  public DateTime LastAccessTime { get; }
  public DateTime LastWriteTime { get; }
  public DateTime ChangeTime { get; }
  public int Attributes { get; }
  public long HandleInfo { get; }
  public IntPtr FileContext { get; set; }
  public IntPtr HandleContext { get; set; }
  public int ResultCode { get; set; }
}
Public Event OnSetFileAttributes As OnSetFileAttributesHandler

Public Delegate Sub OnSetFileAttributesHandler(sender As Object, e As CbfsSetFileAttributesEventArgs)

Public Class CbfsSetFileAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property CreationTime As DateTime
  Public ReadOnly Property LastAccessTime As DateTime
  Public ReadOnly Property LastWriteTime As DateTime
  Public ReadOnly Property ChangeTime As DateTime
  Public ReadOnly Property Attributes As Integer
  Public ReadOnly Property HandleInfo As Long
  Public Property FileContext As IntPtr
  Public Property HandleContext As IntPtr
  Public Property ResultCode As Integer
End Class

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, 1601 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: 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.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 .NET Edition - Version 20.0 [Build 8348]