CBFS Connect 2020 Python Edition

Questions / Feedback?

on_get_volume_label Event

Fires when the OS needs the volume label.

Syntax

class CBFSGetVolumeLabelEventParams(object):
  @property
  def buffer() -> str: ...
  @buffer.setter
  def buffer(value) -> None: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

This event fires anytime the OS needs to retrieve the volume label of the virtual drive.

To handle this event properly, applications must set Buffer to the most recent value obtained via on_set_volume_label.

The length of the returned volume label must not exceed 32 characters, which is the maximum length supported by the OS.

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]