GetVolumeLabel Event

Fires when the OS needs the volume label.

Syntax

// CBFSGetVolumeLabelEventArgs carries the CBFS GetVolumeLabel event's parameters.
type CBFSGetVolumeLabelEventArgs struct {...}

func (args *CBFSGetVolumeLabelEventArgs) Buffer() string
func (args *CBFSGetVolumeLabelEventArgs) SetBuffer(value string)
func (args *CBFSGetVolumeLabelEventArgs) ResultCode() int32
func (args *CBFSGetVolumeLabelEventArgs) SetResultCode(value int32)

// CBFSGetVolumeLabelEvent defines the signature of the CBFS GetVolumeLabel event's handler function.
type CBFSGetVolumeLabelEvent func(sender *CBFS, args *CBFSGetVolumeLabelEventArgs)

func (obj *CBFS) GetOnGetVolumeLabelHandler() CBFSGetVolumeLabelEvent
func (obj *CBFS) SetOnGetVolumeLabelHandler(handlerFunc CBFSGetVolumeLabelEvent)

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 SetVolumeLabel.

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) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Go Edition - Version 20.0 [Build 8348]