SftpProgress method
Called during file transfer.
Type
NoneSyntax
object.SftpProgress Owner, User, PositionLo, PositionHi, TotalLo, TotalHi
The SftpProgress(object,Owner,User,PositionLo,PositionHi,TotalLo,TotalHi) syntax has these parts:
| object | An expression evaluating to an object of type IwodSSHDNotify. |
| Owner | A wodSSHDcom object. Instance of wodSSHServer that called this notification method. |
| User | A SSHUser object. Reference to user who is transferring the file. |
| PositionLo | A Long value. Lower 32bit of current position of file transfer. |
| PositionHi | A Long value. Higher 32bit of current position of file transfer. |
| TotalLo | A Long value. Lower 32bit of total size of file that will be transferred, if known. |
| TotalHi | A Long value. Higher 32bit of total size of file that will be transferred, if known. |
Remarks
SftpProgress notification method is called during file upload or download. You can track and calculate client's speed using this property.
If user is uploading file, its size is not known before upload is completed - thus Total and Position arguments will always contain same value - total number of bytes uploaded so far. Progress event will be fired until file size exceeds 4.2gb. After that size, Progress64 event will be fired instead.
NOTE: it is possible that Position or Total values become negative - it is because unsigned values are used, but VB (and other environments) expect to see signed values.
This method is called only if you implemented IwodSSHNotify interface in your application, and wodSSHD.Notification property has received reference to instance of your implementation.
Platforms
Windows
Back to product page