on_get_disk_size Event

Fires when the OS needs to retrieve the size of the virtual disk.

Syntax

class CBDiskGetDiskSizeEventParams(object):
  @property
  def size() -> int: ...
  @size.setter
  def size(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBDisk:
@property
def on_get_disk_size() -> Callable[[CBDiskGetDiskSizeEventParams], None]: ...
@on_get_disk_size.setter
def on_get_disk_size(event_hook: Callable[[CBDiskGetDiskSizeEventParams], None]) -> None: ...

Remarks

This event fires when the OS needs to retrieve the size of the virtual disk.

To handle this event properly, applications must set Size to reflect the size of the block of data associated with the virtual disk.

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.