Version: 2018.3 (switch to 2019.1a or 2017.4)
LanguageEnglish
  • C#

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

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 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.

Did you find this page useful? Please give it a rating: