The Progress Object
FileUpEE includes a server-side progress indicator that allows you to log and display the
progress of an upload. Note that the progress indicator monitors the whole upload, and cannot watch
the progress of an individual file within an upload.
FileUpEE's progress indicator can monitor uploads from client to Web server, and from Web server
to file server. The progress from client to Web server is measured as the number of bytes
received on the Web server. Progress from Web server to file server is measured as the
number of bytes sent from the Web server; note that this is not proof of arrival on the
file server.
To create an instance of the progress indicator, use:
Set objFileUpProgress = Server.CreateObject("Softartisans.FileUpEEProgress")
| Progress Indicator Properties |
| Percentage |
Syntax
objProgress.Percentage
Description
The Percentage property returns the percentage of the
upload that was:
- Received on the Web server (if the upload is from client to
Web server)
OR
- Sent to the file server (if the upload is from Web server
to file server)
Top |
| ProgressId |
Syntax
objProgress.ProgressId [=Progress Id]
Description
The ProgressId property sets or returns a
progress id number for an upload. FileUpEE automatically generates
a unique progress id for each upload.
Top |
| TotalBytes |
Syntax
objProgress.TotalBytes
Description
The TotalBytes property returns the total number of bytes to be
uploaded.
Top |
| TransferredBytes |
Syntax
objProgress.TransferredBytes
Description
The TransferredBytes property returns the number of bytes
that were:
- Received on the Web server (if the upload is from client to
Web server)
OR
- Sent to the file server (if the upload is from Web server
to file server)
Top |
| Watch |
Syntax
objProgress.Watch =SATransferStage
Description
The Watch property specifies the transfer stage that the
progress indicator should watch: saClient for client to Web server, or
saWebServer for Web server to file server.
Example
The following is from the client script (upload form) in a 3-tier
(client -> Web server -> file server) upload:
'--- Watch the upload from client to Web server. That is,
'--- monitor the upload as it is RECEIVED on the Web server.
oFileUpEEProgressClient.Watch = saClient
'--- Watch the upload from Web server to file server. That
'--- is, monitor the upload as it is SENT FROM the Web server.
oFileUpEEProgressClient.Watch = saWebServer
Top |
| Progress Indicator Methods |
| NextProgressID |
Syntax
objProgress.NextProgressID
Description
NextProgressId returns the next unused
ProgressId.
Example
ProgID = oFileUpEEProgress.NextProgressID
Top |
Copyright © 2003, SoftArtisans, Inc.