Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

UnityWebRequest.Abort

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function Abort(): void;
public void Abort();

Description

If in progress, halts the UnityWebRequest as soon as possible.

This method may be called at any time. If the UnityWebRequest has not already completed, the UnityWebRequest will halt uploading or downloading data as soon as possible. Aborted UnityWebRequests are considered to have encountered a system error. The isError property will return true and the error property will be "User Aborted".

If this method is called prior to calling Send, then the UnityWebRequest will abort immediately after the call to Send.

Calls to this method have no effect after this UnityWebRequest has encountered a different error, or has successfully finished communicating with the remote server.