CBFS Connect 2020 Python Edition

Questions / Feedback?

on_get_volume_size Event

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


class CBFSGetVolumeSizeEventParams(object):
  def total_sectors() -> int: ...
  def total_sectors(value) -> None: ...
  def available_sectors() -> int: ...
  def available_sectors(value) -> None: ...
  def result_code() -> int: ...
  def result_code(value) -> None: ...

# In class CBFS:
def on_get_volume_size() -> Callable[[CBFSGetVolumeSizeEventParams], None]: ...
def on_get_volume_size(event_hook: Callable[[CBFSGetVolumeSizeEventParams], None]) -> None: ...


This event fires anytime the OS needs to retrieve the virtual drive's total storage capacity and free space, measured in sectors. The virtual drive's sector size is defined by the SectorSize configuration setting.

To handle this event properly, applications must set TotalSectors to the total number of sectors on the drive, and set AvailableSectors to the number of sectors that are available to the OS for storing filesystem objects.

The minimum drive size accepted by Windows is 6144 bytes (based on a 3072-byte sector, 1 sector per cluster and 2 clusters per drive). However, the class adjusts the minimum size to be at least 16 sectors (49152 bytes) to ensure compatibility with possible changes in future Windows updates.

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]