The OnProgress event is generated during data transfer.
Syntax
Sub object_OnProgress ( [Index As
Integer], ByVal MessageNumber As Variant,
ByVal MessageSize As Variant, ByVal
MessageCopied As Variant, ByVal Percent
As Variant )
Remarks
The OnProgress event is generated during the transfer of
data between the client and server, indicating the amount of data
exchanged. For transfers of large amounts of data, this event can be
used to update a progress bar or other user-interface control to
provide the user with some visual feedback. The arguments to this
event are:
- MessageNumber
- The number of the message that is being retrieved.
- MessageSize
- The size of the file being transferred in bytes. This value may
be zero if the control cannot obtain the size of the file from the
server.
- MessageCopied
- The number of bytes that have been transferred between the
client and server.
- Percent
- The percentage of data that's been transferred, expressed as an
integer value between 0 and 100, inclusive. If the size of the file
on the server cannot be determined, this value will always be
100.
Note that this event is only generated when message data is
retrieved using the GetHeaders or GetMessage method. If
the client is reading the message data directly from the server using
the Read method, the application is responsible for
calculating the completion percentage and updating any user interface
controls.
See Also
GetHeaders Method,
GetMessage Method
|