on_set_volume_label Event

Fires when the OS wants to change the volume label.

Syntax

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

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

Remarks

This event fires when the OS wants to change the volume label of the virtual drive.

To handle this event properly, applications must store the new volume label specified by VolumeLabel.

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.