on_get_volume_object_id Event

Fires when the OS needs the volume object Id and extended information.

Syntax

class CBFSGetVolumeObjectIdEventParams(object):
  @property
  def object_id() -> c_void_p: ...
  @property
  def object_id_length() -> int: ...
  @property
  def extended_information() -> c_void_p: ...
  @property
  def extended_information_length() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires anytime the OS needs to retrieve the volume object Id and extended information for the virtual drive.

To handle this event properly, applications must populate the ObjectId and ExtendedInformation buffers with the most recent values obtained via on_set_volume_object_id.

The ObjectIdLength and ExtendedInformationLength values are specified by the OS; they will always be 16 and 48 bytes, respectively.

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.