This topic has not yet been rated - Rate this topic

BackgroundDownloadProgress structure

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

VersionAttribute(NTDDI_WIN8)

Members

The BackgroundDownloadProgress structure has these fields.

Field	Data type	Description
BytesReceived \| bytesReceived	Number [JavaScript] \| System.UInt64 [.NET] \| uint64 [C++]	Current 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.
Status \| status	BackgroundTransferStatus	Indicates the current operation status.
TotalBytesToReceive \| totalBytesToReceive	Number [JavaScript] \| System.UInt64 [.NET] \| uint64 [C++]	The total number of data bytes to download. If the number is unknown, this value is 0 by default.

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Windows.Networking.BackgroundTransfer Windows::Networking::BackgroundTransfer [C++]
Metadata	Windows.winmd

Build date: 12/4/2012