on_get_volume_id Event

Fire when the class needs the volume Id.

Syntax

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

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

Remarks

This event fires anytime the class needs to retrieve volume Id of the virtual drive. Ideally, each drive's volume Id should be globally unique.

To handle this event properly, applications must return the virtual drive's volume Id via the VolumeId parameter.

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.