CBFS Connect 2020 Python Edition

Questions / Feedback?

on_get_volume_id Event

Fire when the class needs the volume Id.


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

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


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.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Python Edition - Version 20.0 [Build 7880]