BackgroundUploadProgress BackgroundUploadProgress BackgroundUploadProgress BackgroundUploadProgress Struct

Contains status information about the upload operation.

Syntax

Declaration

public struct BackgroundUploadProgresspublic struct BackgroundUploadProgressPublic Structure BackgroundUploadProgress

Fields summary

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.

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

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.

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.

The current status of the upload operation.

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

The total number of bytes to upload.

Fields

  • BytesReceived
    BytesReceived
    BytesReceived
    BytesReceived

    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.

    public field ulong BytesReceivedpublic field ulong BytesReceivedPublic Field BytesReceived
  • BytesSent
    BytesSent
    BytesSent
    BytesSent

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

    public field ulong BytesSentpublic field ulong BytesSentPublic Field BytesSent
  • HasResponseChanged
    HasResponseChanged
    HasResponseChanged
    HasResponseChanged

    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.

    public field bool HasResponseChangedpublic field bool HasResponseChangedPublic Field HasResponseChanged
  • HasRestarted
    HasRestarted
    HasRestarted
    HasRestarted

    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.

    public field bool HasRestartedpublic field bool HasRestartedPublic Field HasRestarted
  • Status
    Status
    Status
    Status

    The current status of the upload operation.

    public field BackgroundTransferStatus Statuspublic field BackgroundTransferStatus StatusPublic Field Status
  • TotalBytesToReceive
    TotalBytesToReceive
    TotalBytesToReceive
    TotalBytesToReceive

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

    public field ulong TotalBytesToReceivepublic field ulong TotalBytesToReceivePublic Field TotalBytesToReceive
  • TotalBytesToSend
    TotalBytesToSend
    TotalBytesToSend
    TotalBytesToSend

    The total number of bytes to upload.

    public field ulong TotalBytesToSendpublic field ulong TotalBytesToSendPublic Field TotalBytesToSend

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Networking.BackgroundTransfer.dll