property OnProtocolStatus : TProtocolStatusEvent
TProtocolStatusEvent = procedure(
CP : TObject; Options : Word) of object;
Defines an event handler that is called regularly during a file transfer.
This event is generated for each block transmitted or received, after the completion of each major operation (e.g., renaming a file, detecting an error, ending the transfer), and at intervals of StatusInterval seconds (by default 1 second). The program can use it to update a status display that informs the user about the protocol progress.
CP is the protocol component that is in progress. A number of the properties of this component can be read to establish the status of the transfer. Options is set to apFirstCall (1) on the first call to the handler, apLastCall (2) on the last call to the handler, and zero on all other calls.
A predefined status component called TApxProtocolStatus is supplied with Async Professional CLX. For a standard protocol status window you can simply create an instance of this component and assign it to the StatusDisplay property of the TApxProtocol component. If you do so, there is no need to supply your own OnProtocolStatus event handler.
See "Protocol status" in the printed documentation for more information.
See also: StatusDisplay, StatusInterval