GetVolumeId Event

Fire when the component needs the volume Id.

Syntax

// CBFSGetVolumeIdEventArgs carries the CBFS GetVolumeId event's parameters.
type CBFSGetVolumeIdEventArgs struct {...}

func (args *CBFSGetVolumeIdEventArgs) VolumeId() int32
func (args *CBFSGetVolumeIdEventArgs) SetVolumeId(value int32)
func (args *CBFSGetVolumeIdEventArgs) ResultCode() int32
func (args *CBFSGetVolumeIdEventArgs) SetResultCode(value int32)

// CBFSGetVolumeIdEvent defines the signature of the CBFS GetVolumeId event's handler function.
type CBFSGetVolumeIdEvent func(sender *CBFS, args *CBFSGetVolumeIdEventArgs)

func (obj *CBFS) GetOnGetVolumeIdHandler() CBFSGetVolumeIdEvent
func (obj *CBFS) SetOnGetVolumeIdHandler(handlerFunc CBFSGetVolumeIdEvent)

Remarks

This event fires anytime the component 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.