OnGetVolumeId event/delegate/callback


Pascal    C++ (Lib)    C++ (VCL)    C++ (.NET)    C#    VB.NET    Java 



The event is fired when CBFS Connect needs to get the volume ID.


    property OnGetVolumeID : TCBGetVolumeIdEvent;
    TCBGetVolumeIdEvent = procedure( Sender : TObject; var VolumeID: LongWord ) of object;

[C++ (Lib)]
    void (__stdcall *CBGetVolumeIdEvent)(void* Sender, unsigned long * VolumeID );

[C++ (VCL)]
    typedef void (__closure *TCBGetVolumeIdEvent)( System::TObject* Sender, unsigned long &VolumeID );

[C++ (.NET)]
    public __delegate void CBGetVolumeIdEvent( CBFSConnect^ Sender, UInt32% VolumeID );

    public void CBGetVolumeIdEvent( CBFSConnect Sender, ref UInt32 VolumeID );

    Sub CBGetVolumeIdEvent( ByVal Sender As CBFSConnect, ByRef VolumeID As UInt32 )

    void ICbFsVolumeEvents.onGetVolumeID( CBFSConnect sender, intRef volumeID );


  • Sender - reference to the class that called the delegate/event handler
  • VolumeID - the event handler must place the volume ID to this parameter


This event is fired when CBFS Connect wants to obtain the volume Id. The volume Id is unique user defined value (within CBFS Connect volumes).

Error handling

See Error handling topic for detailed information about how to report errors, which occur in the event handlers, back to CBFS Connect. Throwing ECBFSConnectError exception from this event handler will not cause the OS to abort the operation or display an error message to the user.