GetVolumeId Event

Fire when the component needs the volume Id.

Syntax

typedef struct {
  int VolumeId;
  int ResultCode;
} TcbcCBFSGetVolumeIdEventParams;

typedef void __fastcall (__closure *TcbcCBFSGetVolumeIdEvent)(System::TObject* Sender, TcbcCBFSGetVolumeIdEventParams *e);

__property TcbcCBFSGetVolumeIdEvent OnGetVolumeId = { read=FOnGetVolumeId, write=FOnGetVolumeId };

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.