BackgroundDownloadProgress BackgroundDownloadProgress BackgroundDownloadProgress BackgroundDownloadProgress BackgroundDownloadProgress Struct

Definition

Contains status information about the download operation.

public : struct BackgroundDownloadProgress
struct winrt::Windows::Networking::BackgroundTransfer::BackgroundDownloadProgress
public struct BackgroundDownloadProgress
Public Structure BackgroundDownloadProgress
var backgroundDownloadProgress = {

   bytesReceived: /* Your value */,

   hasResponseChanged: /* Your value */,

   hasRestarted: /* Your value */,

   status: /* Your value */,

   totalBytesToReceive: /* Your value */

}
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Fields

BytesReceived BytesReceived BytesReceived BytesReceived BytesReceived

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 HasResponseChanged HasResponseChanged HasResponseChanged

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 HasRestarted HasRestarted HasRestarted

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 Status Status Status

A BackgroundTransferStatus containing the current status of the download operation.

TotalBytesToReceive TotalBytesToReceive TotalBytesToReceive TotalBytesToReceive TotalBytesToReceive

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

See also