on_set_quotas Event

Fires when the OS needs to update quota information.

Syntax

class CBFSSetQuotasEventParams(object):
  @property
  def sid() -> c_void_p: ...
  @property
  def sid_length() -> int: ...
  @property
  def remove_quota() -> bool: ...
  @property
  def quota_found() -> bool: ...
  @quota_found.setter
  def quota_found(value) -> None: ...
  @property
  def quota_used() -> int: ...
  @property
  def quota_threshold() -> int: ...
  @property
  def quota_limit() -> int: ...
  @property
  def enumeration_context() -> int: ...
  @enumeration_context.setter
  def enumeration_context(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS needs to set, update, or remove quota information for the security identifier specified by SID. If quota information needs to be set/updated/removed for multiple SIDs, this event will fire multiple times in succession.

This event only needs to be handled if the use_disk_quotas property is enabled. To handle this event properly, applications must either store or remove the quota information for the security identifier specified by SID:

• If RemoveQuota is False, set or update the SID's quota information using the values specified by QuotaUsed, QuotaFound, and QuotaLimit.
• If RemoveQuota is True, and the application has quota information stored for the SID, remove that information and set QuotaFound to True. If the application does not have quota information stored for the SID, set QuotaFound to False.

Both this event and on_query_quotas cause a quota enumeration to be started; the on_close_quotas_enumeration event will fire when the OS has finished setting/updating/removing quota information.

Descriptions of the QuotaUsed, QuotaThreshold, and QuotaLimit parameters can be found in the Windows API's DISKQUOTA_USER_INFORMATION structure documentation.

The EnumerationContext parameter is a placeholder for application-defined data associated with the enumeration. Please refer to the Contexts topic for more information.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

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.