CBFS Connect 2020 Python Edition

Questions / Feedback?

on_set_volume_object_id Event

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


class CBFSSetVolumeObjectIdEventParams(object):
  def object_id() -> c_void_p: ...
  def object_id_length() -> int: ...
  def extended_information() -> c_void_p: ...
  def extended_information_length() -> int: ...
  def result_code() -> int: ...
  def result_code(value) -> None: ...

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


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

To handle this event properly, applications must store the values specified by ObjectId and ExtendedInformation.

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.

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