Discuss this help topic in CBFS Forum

OnGetVolumeId event/delegate/callback


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



The event is fired when Callback File System needs to get the volume ID.


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

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

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

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

    public void CbFsGetVolumeIDEvent( CallbackFileSystem Sender, ref UInt32 VolumeID );

    Sub CbFsGetVolumeIDEvent( ByVal Sender As CallbackFileSystem, ByRef VolumeID As UInt32 )

    void ICbFsVolumeEvents.onGetVolumeID( CallbackFileSystem 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 Callback File System wants to obtain the volume Id. The volume Id is unique user defined value (within Callback File System volumes).

Error handling

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

Discuss this help topic in CBFS Forum