DownloadFile Event

An override for a file download initiation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  int OperationStatus;
} TsbxFTPServerDownloadFileEventParams;

typedef void __fastcall (__closure *TsbxFTPServerDownloadFileEvent)(System::TObject* Sender, TsbxFTPServerDownloadFileEventParams *e);

__property TsbxFTPServerDownloadFileEvent OnDownloadFile = { read=FOnDownloadFile, write=FOnDownloadFile };

Remarks

The component fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeDownloadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of ReadFile calls, requesting the file data from your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values: