on_disk_write Event

Fires when the OS needs to write data to the virtual disk.

Syntax

class CBDiskDiskWriteEventParams(object):
  @property
  def offset() -> int: ...
  @property
  def buffer() -> c_void_p: ...
  @property
  def bytes_to_write() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires when the OS needs to write data to the virtual disk.

To handle this event properly, applications must write BytesToWrite bytes to the block of data associated with the virtual disk, copying it from the memory region pointed to by Buffer. Writing must begin at the specified Offset in the data block; and applications must either write exactly BytesToWrite bytes, or return an error via ResultCode (i.e., partial writes are not a successful outcome). Applications must not attempt to copy more than BytesToWrite bytes of data from Buffer.

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.