Notification Event
This event notifies the application about an underlying control flow event.
Syntax
typedef struct {
String EventID;
String EventParam;
} TsbxFTPServerNotificationEventParams;
typedef void __fastcall (__closure *TsbxFTPServerNotificationEvent)(System::TObject* Sender, TsbxFTPServerNotificationEventParams *e);
__property TsbxFTPServerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component can fire this event with the following EventID values:
| DownloadProgress | Reports the progress of the current download operation.
The EventParam value passed with this EventID is a string of the
following format:
ConnectionID=3;Path=/dir/file;Progress=2048;Total=16000 |
| UploadProgress | Reports the progress of the current upload operation. The format of EventParam is identical to the one used by the DownloadProgress. |
| DownloadBegin | Indicates the start of the download operation. The
EventParam value has the following format:
ConnectionID=8;Path=/dir/file |
| UploadBegin | Indicates the start of the upload operation. The EventParam format is the same as with the DownloadBegin event ID. |
| DownloadEnd | Indicates the completion of the download operation. The
EventParam value has the following format:
ConnectionID=8;Path=/dir/file |
| UploadEnd | Indicates the completion of the upload operation. The EventParam format is the same as with the DownloadEnd event ID. |