OnFileTransferStatusUpdate Event

Fired periodically during a file transfer with information regarding the progress of the operation.

Syntax

[Visual Basic]
Private Sub myPortController_OnFileTransferStatusUpdate(ByVal sender As Object, _
ByVal e As SciCom.PortController.FileTransferStatusEventArgs) Handles _
myPortController.OnFileTransferStatusUpdate

[C#]
private void OnFileTransferStatusUpdate(object sender, SciCom.PortController.FileTransferStatusEventArgs e)

[C++]
System::Void OnFileTransferStatusUpdate(System::Object * sender, SciCom::PortController::FileTransferStatusEventArgs * e)

Parameters

sender

A reference to the PortController object.

e

The arguments associated with the event.

Arguments

FileName: A string containing the name of the file currently being sent or received
BytesTransferred: An integer representing the number of bytes transferred for the file currently being sent or received
FileLength: An integer representing the size of the file being sent or received (if available)

Remarks

• XMODEM, XMODEM-CRC, XMODEM-1K, and YMODEM require the total number of bytes transferred to be padded to a multiple of 128 or 1024. Therefore, it is possible that the actual number of bytes transferred will be greater than the file length. Even if this occurs, however, the BytesTransferred argument will never be greater than FileLength
• XMODEM, XMODEM-CRC, and XMODEM-1K do not send any file information to the receiver. Therefore, when receiving a file using one of these protocols, no file length information will be availble. FileLength, therefore, will always be 0.

See Also