OnProgress Event  
 

The OnProgress event is generated during data transfer.

Syntax

Sub object_OnProgress ( [Index As Integer], 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:

MessageSize
The size of the message being transferred in bytes.
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.

Note that this event is only generated when a message is delivered using the SendMessage method. If the client is writing the message data directly to the server using Write method then the application is responsible for calculating the completion percentage and updating any user interface controls.

See Also

SendMessage Method