Show / Hide Table of Contents

Method Cancel

Cancel()

Cancels execution of the job

Declaration
[Obsolete("Use CancelAsync instead to allow asynchronous server-side cancellation to complete.")]
public bool Cancel()
Returns
Type Description
Boolean

false if already canceled or cannot be cannot be canceled; otherwise, true.

Remarks

The job is canceled and goes into a failure status Failed. For jobs running on a server, a cancel request will be sent for the associated ServerJobId. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. For example, server-side jobs include:

  • ExportTileCacheJob
  • ExportVectorTilesJob
  • GenerateGeodatabaseJob
  • GeoprocessingJob

In addition, the GenerateOfflineMapJob is composed of several server-side jobs, depending on the types of layers in your Map. Canceling this high-level job will also send a cancel request to the underlying server jobs.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 100.15
.NET 6.0100.13 - 100.15
.NET 6.0 Windows100.13 - 100.15
.NET Framework100.0 - 100.15
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Xamarin.Android100.0 - 100.15
Xamarin.iOS100.0 - 100.15
UWP100.0 - 100.15
In This Article
Back to top Copyright © 2022 Esri.