BackgroundDownloadProgress structure

Applies to Windows and Windows Phone

Contains status information about the download operation.

Syntax


var backgroundDownloadProgress = {
    bytesReceived : /* Your value */,
    hasResponseChanged : /* Your value */,
    hasRestarted : /* Your value */,
    status : /* Your value */,
    totalBytesToReceive : /* Your value */
}

Attributes

[Version(0x06020000)]

Members

The BackgroundDownloadProgress 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 response headers.

If the download 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 download 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 data transfer operation has restarted; otherwise false.

When a download is interrupted and a new request is sent to the server to resume the download, HasRestarted is set to true if the server does not support resume and the download had to start over.

HasRestarted is set to true only in the first progress notification sent after the restart. After the first progress notification, HasRestarted is set to false in later notifications.

Status | status

BackgroundTransferStatus

The current status of the download operation.

TotalBytesToReceive | totalBytesToReceive

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

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

 

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

BackgroundUploadProgress
DownloadOperation
Progress

 

 

Show:
© 2014 Microsoft