TransferRate property
Returns average speed of the file transfer.
Type
A Long value. Specifies average speed, in bytes/sec.Syntax
object.TransferRate
The TransferRate(object,value) syntax has these parts:
| object | An expression evaluating to an object of type wodSFTP. |
| value | A Long value. |
Remarks
TransferRate defines how much maximum bandwidth wodSFTP currently use. You can call it to get current transfer rate (calculated as average value from the time transfer started), or to get average value of last file transfer (if it has already finished). Typically, you will use it from
Progress event, or from
Done event. Value is shown in "bytes per second" ratio.
To get correct kilobytes and megabytes per second values, you should divide desired bps rate with 1024 or 1024^2, not 1000.
If you want to see what was duration of the file transfer, you can check
TransferTime property.
Back to product page