Back to product page

ProgressEvent event


Fires during file transfers to show current progress of the upload or download.

Syntax

  • C#
  • VB.NET
delegate void ProgressDelegate(object Sender, ProgressArgs Args);
The ProgressEvent(Args.Length,Args.Position) syntax has these parts:
Args.LengthUnsigned long. Total file length.
Args.PositionUnsigned long. Current position in file transfer.

Delegate Sub ProgressDelegate(ByVal Sender As Object, ByVal Args As WeOnlyDo.Client.SFTP.ProgressArgs)
The ProgressEvent(Args.Length,Args.Position) syntax has these parts:
Args.LengthUnsigned long. Total file length.
Args.PositionUnsigned long. Current position in file transfer.

Remarks

This event can be used for monitoring file transfers. It is fired during file transfer started by GetFile or PutFile methods. It will be fired several times, depending on your network speed (thus length of packets sent/received), file size, or something else. There is no default rule on exact number of times it will be fired. Once transfer is finished, Position argument will have the same value as Length argument.

Also, once file transfer is finished Done event will be fired.

Platforms

Windows