StatFS Event

Fires when the OS needs information about the virtual drive's capacity and free space.

Syntax

• C#
• VB.NET

public event OnStatFSHandler OnStatFS;

public delegate void OnStatFSHandler(object sender, FuseStatFSEventArgs e);

public class FuseStatFSEventArgs : EventArgs {
  public string Path { get; }
  public long BlockSize { get; set; }
  public long TotalBlocks { get; set; }
  public long FreeBlocks { get; set; }
  public long FreeBlocksAvail { get; set; }
  public long TotalFiles { get; set; }
  public long FreeFiles { get; set; }
  public int MaxFilenameLength { get; set; }
  public int Result { get; set; }
}

Public Event OnStatFS As OnStatFSHandler

Public Delegate Sub OnStatFSHandler(sender As Object, e As FuseStatFSEventArgs)

Public Class FuseStatFSEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public Property BlockSize As Long
  Public Property TotalBlocks As Long
  Public Property FreeBlocks As Long
  Public Property FreeBlocksAvail As Long
  Public Property TotalFiles As Long
  Public Property FreeFiles As Long
  Public Property MaxFilenameLength As Integer
  Public Property Result As Integer
End Class

Remarks

This event fires anytime the OS needs to retrieve the virtual drive's total storage capacity and free space. This event is mandatory to handle, since without it, the OS won't be able to initialize the drive.

To handle this event properly, applications must set event parameters accordingly. BlockSize must be set to the size of the block. TotalBlocks must be set to the total number of blocks on the virtual drive, while FreeBlocks and FreeBlocksAvail denote the number of free blocks available to the system and to the unprivileged user respectively.

Windows:

The minimum drive size accepted by Windows is 6144 bytes. However, the component adjusts the minimum size to be at least 49152 bytes to ensure compatibility with possible changes in future Windows updates.

Linux:

TotalFiles and FreeFiles must be set to the total and available number of file slots (inodes) available within a filesystem. MaxFilenameLength should be set to the maximal length of the filename (path component) supported by the filesystem.

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 negative error code value (e.g. -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.