Description
-
Determines maximum upload/download speed.
Return type
-
A Long value. Specifies maximum upload/download speed, in
bytes/sec.
Syntax
-
long Sftp_GetMaxTransferRate(void *Sftp, long
*pVal); long
Sftp_SetMaxTransferRate(void *Sftp, long
newVal);
The MaxTransferRate function syntax has these parts:
Remarks
-
MaxTransferRate defines how much maximum bandwidth wodSFTPdll can
use. It is presented as 'bytes per second', both for upload and
download. When set to 0 (default value), there is no bandwidth
limit.
You can change this property at any time, and wodSFTP will be
affected immediately. If you calculate current speed, you could do
that from the Progress
callback. If you want to restrict speed for, for example, only
downloads, you can set MaxTransferRate property just before
calling GetFile. Same
applies for PutFile as
well. Please note that if
Compression
property was set, Progress callback calculations will show
much higher speed than real one. If you want to get accurate
information, set Compression to 0.
To get correct kilobytes and megabytes per second values, you should
multiply desired bps rate with 1024 or 1024^2, not 1000.
Your calculated bps values may have up to 10% difference than your
MaxTransferRate setting.
|