Show / Hide Table of Contents

Method StartAsync

StartAsync()

Asynchronously starts the local geoprocessing service.

Declaration
public override Task StartAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous start operation.

Overrides
LocalService.StartAsync()
Remarks

The StartAsyncTask method will check whether this local service is already in the Started state and raise an System.InvalidOperationException if necessary. The PackagePath property will also be checked for a valid geoprocessing package.

Exceptions
Type Condition
System.InvalidOperationException

StartAsyncTask should can not be called if the local service is already in the Started state.

System.InvalidOperationException

An exception is raised if the PackagePath property does not reference a valid geoprocessing package file.

Applies to

Platforms and versions
TargetVersions
.NET Windows100.13 - 200.8
.NET Framework100.0 - 200.8

StartAsync(CancellationToken)

Asynchronously starts the local geoprocessing service.

Declaration
public override Task StartAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous start operation.

Overrides
LocalService.StartAsync(CancellationToken)
Remarks

The StartAsyncTask method will check whether this local service is already in the Started state and raise an System.InvalidOperationException if necessary. The PackagePath property will also be checked for a valid geoprocessing package.

Exceptions
Type Condition
System.InvalidOperationException

StartAsyncTask should can not be called if the local service is already in the Started state.

System.InvalidOperationException

An exception is raised if the PackagePath property does not reference a valid geoprocessing package file.

System.Threading.Tasks.TaskCanceledException

The operation was cancelled

Applies to

Platforms and versions
TargetVersions
.NET Windows100.13 - 200.8
.NET Framework100.13 - 200.8
In This Article
Back to top Copyright © 2022 Esri.