Progress event
Fires during file send/receive operations.
Syntax
Private Sub object_Progress(Position, Total)
The Progress(object,Position,Total) syntax has these parts:
| object | A wodSFTP object. |
| Position | A Long value. Current transfer position. |
| Total | A Long value. Total number of bytes that should be transferred. |
Remarks
This event can be used for monitoring file transfers. It is fired during file transfers 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 the transfer is finished, the
Position argument will have the same value as the
Total argument. As long as file size fits into a 32bit long integer, then the Progress event will be fired. If either of the position or the total arguments do not fit into a 32bit long integer, then the
Progress64 event will be fired instead. Depending on the programming language you use, you will need to convert these values into appropriate int64 integers.
Also, once the file transfer is complete, the
Done event will be fired.
Platforms
Windows
Back to product page