BackgroundUploadProgress structure

Applies to Windows and Windows Phone

Contains status information about the upload operation.

Syntax

Public Structure BackgroundUploadProgress

Attributes

[Version(0x06020000)]

Members

The BackgroundUploadProgress structure has these fields.

FieldData typeDescription
BytesReceived | bytesReceived

Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++]

The total number of bytes received. This value does not include bytes received as part of response headers. If the upload operation has restarted, this value may be smaller than in the previous progress report.

BytesSent | bytesSent

Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++]

The total number of bytes sent. If the upload operation has restarted, this value may be smaller than in the previous progress report.

HasResponseChanged | hasResponseChanged

Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

TRUE if the upload request response has changed; otherwise, FALSE.

Whenever new response information is available due to a new request being invoked, this field is set to true. The application can then choose to read the new response information and update its state, if needed.

HasRestarted | hasRestarted

Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

true if a upload transfer operation has restarted; otherwise false.

Uploads cannot be resumed. Whenever a new request is sent to the server to restart the upload, this property is set to true in the first progress notification for the new request. After the first progress notification, HasRestarted is set to false in later notifications.

Status | status

BackgroundTransferStatus

The current status of the upload operation.

TotalBytesToReceive | totalBytesToReceive

Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++]

The total number of bytes of data to upload. If this number is unknown, this value is set to 0.

TotalBytesToSend | totalBytesToSend

Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++]

The total number of bytes to upload.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Networking.BackgroundTransfer
Windows::Networking::BackgroundTransfer [C++]

Metadata

Windows.winmd

See also

BackgroundDownloadProgress
Progress
UploadOperation

 

 

Show:
© 2014 Microsoft. All rights reserved.