| |
The OnProgress event is generated during data transfer.
Syntax
Sub object_OnProgress ( [Index As
Integer], ByVal BytesTotal As Variant,
ByVal BytesCopied 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:
- BytesTotal
- A value that specifies the total amount of data being transferred in
bytes. This value may be zero if the control cannot determine the total
amount of data that will be copied. If the total number of bytes is
less than 2 GiB, the value will be a Long (32-bit) integer.
For very large transfers, it will be a Double
floating-point value.
- BytesCopied
- A value that specifies the number of bytes that have been transferred
between the client and server. If the number of bytes copied is less than
2 GiB, the value will be a Long (32-bit) integer. For very
large transfers, it will be a Double floating-point
value.
- 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.
This event is only generated when data is transferred
using the GetData, GetFile, PostData,
PostFile, PutData or PutFile methods. If the
client is reading or writing the file data directly to the server
using the Read or Write methods then the application is
responsible for calculating the completion percentage and updating
any user interface controls.
See Also
TransferBytes Property,
TransferRate Property,
TransferTime Property,
GetData Method,
GetFile Method,
PostData Method,
PostFile Method,
PutData Method,
PutFile Method
|
|