Progress method
Called during file sending or receiving.
Type
NoneSyntax
object.Progress Owner, Position, Total
The Progress(object,Owner,Position,Total) syntax has these parts:
| object | An expression evaluating to an object of type IwodSFTPNotify. |
| Owner | A wodSFTPCom object. |
| Position | A Long value. Current transfer position. |
| Total | A Long value. 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, then the
Progress64 notification method will be fired 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.
Platforms
Windows
Back to product page