Progress method
Called during file sending or receiving.
Type
NoneSyntax
object.Progress Owner, Code, Reply
The Progress(object,Owner,Position,Total) syntax has these parts:
| object | An expression evaluating to an object of type IwodFtpNotify. |
| Owner | Required. A wodFtpDLXCom object. |
| Position | Required. A Long value. Position within current file transfer. |
| Total | Required. A Long value. Total number of bytes that should be transferred. |
Remarks
This method is called only if you implemented IwodFtpNotify interface in your application, and wodFtpDLX.Notification property has received reference to instance of your implementation.
This notification method can be used for monitoring file transfers. It is called during file transfer started by
GetFile or
PutFile methods. It will be called 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 called. Once transfer is finished,
Position argument will have the same value as
Total argument.
Once transfer is finished, Position argument will have the same value as Total argument. As long as total file size does fit in 32bit long integer, Progress notification will be called. If position or total arguments does not fit anymore in 32bit long integer,
Progress64 notification will be fired instead. Depending on the programming language you use, you will need to convert these values to appropriate int64 integer.
Also, once file transfer is finished
Done notification method will be called.
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. If this happens, we suggest you call Progress64 notification from within Progress notification, and apply code as shown in Progress64 help page.
Platforms
Windows
Back to product page