Back to product page

Progress64 method


Called during file sending or receiving.

Type

None

Syntax

  • Basic
object.Progress64 Owner, PositionLo, PositionHi, TotalLo, TotalHi
The Progress64(object,Owner,PositionLo,PositionHi,TotalLo,TotalHi) syntax has these parts:
objectAn expression evaluating to an object of type IwodSFTPNotify.
OwnerA wodSFTPCom object.
PositionLoA Long value. Lower long value of 64bit integer for current transfer position.
PositionHiA Long value. Higher long value of 64bit integer for current transfer position.
TotalLoA Long value. Lower long value of 64bit integer for total number of bytes that should be transferred.
TotalHiA Long value. Higher long value of 64bit integer for total number of bytes that should be transferred.

Remarks

This method is only called if you implemented the IwodSFTPNotify interface in your application and the wodSFTP.Notification property has received a reference to an instance of your implementation.

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

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

Also, once the file transfer is complete, the Done notification method will be called.

Code sample

  • Basic

Platforms

Windows