SetVolumeObjectId Event

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

Syntax

// CBFSSetVolumeObjectIdEventArgs carries the CBFS SetVolumeObjectId event's parameters.
type CBFSSetVolumeObjectIdEventArgs struct {...}

func (args *CBFSSetVolumeObjectIdEventArgs) ObjectId() []byte
func (args *CBFSSetVolumeObjectIdEventArgs) ObjectIdLength() int32
func (args *CBFSSetVolumeObjectIdEventArgs) ExtendedInformation() []byte
func (args *CBFSSetVolumeObjectIdEventArgs) ExtendedInformationLength() int32
func (args *CBFSSetVolumeObjectIdEventArgs) ResultCode() int32
func (args *CBFSSetVolumeObjectIdEventArgs) SetResultCode(value int32)

// CBFSSetVolumeObjectIdEvent defines the signature of the CBFS SetVolumeObjectId event's handler function.
type CBFSSetVolumeObjectIdEvent func(sender *CBFS, args *CBFSSetVolumeObjectIdEventArgs)

func (obj *CBFS) GetOnSetVolumeObjectIdHandler() CBFSSetVolumeObjectIdEvent
func (obj *CBFS) SetOnSetVolumeObjectIdHandler(handlerFunc CBFSSetVolumeObjectIdEvent)

Remarks

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