Remove Method
Collapse the table of content
Expand the table of content

BackgroundTransferService.Remove Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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


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.


The specified BackgroundTransferRequest cannot be null.


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

© 2016 Microsoft