OnFileClose event/delegate/callback

Navigation

Send comments on this topic

Pascal DLL C++ (DLL/Lib) C++ (VCL) C++ (.NET) C# VB.NET

This event is fired when storage needs to be closed.

[Pascal]
TSolFSCloseFileEvent = procedure( Sender : TObject; var FileHandle : THandle; var Result : LongInt) of object;

[DLL]
typedef Error (__stdcall *SolFSCloseFileFunc)( LongWord UserData, PHandle FileHandle);

[C++ (DLL/Lib)]
typedef Error (__stdcall *SolFSCloseFileFunc)( LongWord UserData, PHandle FileHandle);

[C++ (VCL)]
typedef void (__closure *TSolFSCloseFileEvent)( System::TObject* Sender, PHandle FileHandle, Error& Result);

[C++ (.NET)]
public __delegate void SolFSCloseFileEvent( SolFSStorage* Sender, UInt32 __gc &FileHandle, Int32 __gc &Result);

[C#]
public void SolFSCloseFileEvent( SolFS.SolFSStorage Sender, ref uint FileHandle, ref int Result);

[VB.NET]
Sub SolFSCloseFileEvent( ByVal Sender As SolFS.SolFSStorage, ByRef FileHandle As UInt32, ByRef Result As Int32)

Sender - reference to the class that called the delegate/event handler.
FileHandle - Handle to the storage that needs to be closed. After call to Close the handle should become invalid. It makes sense to set it back to -1 ($FFFFFFFF, 0xFFFFFFFF).
Result - out parameter (return value for DLL) is where the application places the result of the operation. If you are working with file system, Win32 error code is a good candidate for placing to Result parameter. Otherwise you can use any other error codes, just be sure that 0 means success.
[DLL] UserData - application-defined parameter which is specified when creating the storage and passed back to callback function.

The event is fired when storage is to be closed.