on_get_default_quota_info Event

Fires when the OS needs the virtual drive's default quota information.

Syntax

class CBFSGetDefaultQuotaInfoEventParams(object):
  @property
  def default_quota_threshold() -> int: ...
  @default_quota_threshold.setter
  def default_quota_threshold(value) -> None: ...
  @property
  def default_quota_limit() -> int: ...
  @default_quota_limit.setter
  def default_quota_limit(value) -> None: ...
  @property
  def file_system_control_flags() -> int: ...
  @file_system_control_flags.setter
  def file_system_control_flags(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFS:
@property
def on_get_default_quota_info() -> Callable[[CBFSGetDefaultQuotaInfoEventParams], None]: ...
@on_get_default_quota_info.setter
def on_get_default_quota_info(event_hook: Callable[[CBFSGetDefaultQuotaInfoEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs the default quota information, set during an earlier on_set_default_quota_info event, for the virtual drive.

This event only needs to be handled if the use_disk_quotas property is enabled. To handle this event properly, applications must return the virtual drive's default quota information by setting DefaultQuotaThreshold, DefaultQuotaLimit, and FileSystemControlFlags.

Descriptions of the DefaultQuotaThreshold, DefaultQuotaLimit, and FileSystemControlFlags parameters can be found in the Windows API's FILE_FS_CONTROL_INFORMATION structure documentation.

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.