| |
The OnProgress event is generated during data transfer.
Syntax
Sub object_OnProgress (
[Index As Integer],
ByVal ObjectLabel As Variant,
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 application and storage 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:
- ObjectLabel
- A string value that specifies the name of the object that is
being uploaded or downloaded.
- BytesTotal
- A numeric 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 numeric 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.
This event is only generated when data is transferred
using the GetData, GetFile, PutData or PutFile
methods.
See Also
TransferBytes Property,
TransferRate Property,
TransferTime Property,
GetData Method,
GetFile Method,
PutData Method,
PutFile Method
|
|