Edit

WebClient.CancelAsync Method

  • Reference

Definition

Namespace:
System.Net
Assembly:
System.Net.WebClient.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
WebClient.cs
Source:
WebClient.cs
Source:
WebClient.cs

Cancels a pending asynchronous operation.

public:
 void CancelAsync();
public void CancelAsync ();
member this.CancelAsync : unit -> unit
Public Sub CancelAsync ()

Remarks

If an operation is pending, this method calls Abort on the underlying WebRequest.

Note

Starting in .NET Core 2.0, CancelAsync doesn't cancel the request immediately if the response has started to fetch. For optimum cancellation behavior, use the HttpClient class instead of WebClient.

When you call CancelAsync, your application still receives the completion event associated with the operation. For example, when you call CancelAsync to cancel a DownloadStringAsync operation, if you have specified an event handler for the DownloadStringCompleted event, your event handler receives notification that the operation has ended. To learn whether the operation completed successfully, check the Cancelled property on the base class of DownloadDataCompletedEventArgs in the event data object passed to the event handler.

If no asynchronous operation is in progress, this method does nothing.

Applies to