Back to product page

Progress64 event


Fires during file send/receive operations.

Syntax

  • Basic
Private Sub object_Progress64(PositionLo, PositionHi, TotalLo, TotalHi)
The Progress64(object,PositionLo,PositionHi,TotalLo,TotalHi) syntax has these parts:
objectA wodSFTP object.
PositionLoA Long value. Lower long value of a 64bit integer for the current transfer position.
PositionHiA Long value. Higher long value of a 64bit integer for the current transfer position.
TotalLoA Long value. Lower long value of a 64bit integer for the total number of bytes that should be transferred.
TotalHiA Long value. Higher long value of a 64bit integer for the total number of bytes that should be transferred.

Remarks

This event can be used for monitoring file transfers. It is fired during any file transfer started by the GetFile or PutFile methods. It will be fired several times, depending on the speed of your network (thus the length of packets sent/received), file size and other factors. There is no default rule defining the exact number of times it will be fired.

Once a transfer is finished, the Position argument will have the same value as the Total argument. As long as file size does fit into a 32bit long integer, the Progress event will be fired. If either of the position or total arguments do not fit into a 32bit long integer, the Progress64 event will be fired instead. Depending on the programming language you use, you will need to convert these values to appropriate int64 integers.

Also, once a file transfer is finished, the Done event will be fired.

Code sample

  • Basic

Platforms

Windows