Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BackgroundTransferService.Remove Method

July 28, 2014

Attempts to remove the background transfer request with the specified ID.

Namespace:  Microsoft.Phone.BackgroundTransfer
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)

public static void Remove(
	BackgroundTransferRequest request
)

Parameters

request
Type: Microsoft.Phone.BackgroundTransfer.BackgroundTransferRequest
The transfer request to be removed.

Use the Find(String) method to retrieve a BackgroundTransferRequest object associated with a particular request ID. The retrieved object can be passed to Remove to remove it from the system.

After removing a transfer, if the TransferStatus is not already Completed, the TransferStatusChanged event will be fired and the request’s TransferError property will be set to an InvalidOperationException with the message “The request has previously been cancelled.”

This method may throw one of the following exceptions.

ArgumentNullException

The specified BackgroundTransferRequest cannot be null.

InvalidOperationException

The request has previously been cancelled.

The specified transfer request was not found in the queue.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Show:
© 2014 Microsoft