"cancelDownload"
This function stops a specific download from continuing.
Synopsis
int shape.cancelDownload(uint downloadId);
Parameters
Parameter | Description |
---|---|
downloadId | The ID of the download you want to cancel. This ID is provided in the downloadStatusUpdated event. |
Return Value
The function will return 0 if the download was successfully cancelled. If there is an error, it will return -1.
Details
This function stops the specified download. After the cancellation, the downloadStatusUpdated event will be triggered with the status 3 – DownloadCancelled.