Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

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

DownloadHandler.Dispose

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

Sumbission failed

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

Close

Cancel

public function Dispose(): void;
public void Dispose();

Description

Signals that this [DownloadHandler] is no longer being used, and should clean up any resources it is using.

This method must be called once you have finished using a [DownloadHandler] object.

For convenience, [UnityWebRequest] exposes the [UnityWebRequest.disposeDownloadHandlerOnDispose] property, which will automatically call this method when [UnityWebRequest.Dispose] is called.

If you elect not to use [UnityWebRequest.disposeDownloadHandlerOnDispose] (by setting it to false), then you must call Dispose on the [DownloadHandler] yourself. This should only be in rare cases, such as when you wish to save the data in the [DownloadHandler]'s internal buffer(s) for later processing.