Show / Hide Table of Contents

Method TraceAsync

TraceAsync(UtilityTraceParameters, CancellationToken)

Asynchronously begins a trace with the supplied UtilityTraceParameters.

Declaration
public Task<IEnumerable<UtilityTraceResult>> TraceAsync(UtilityTraceParameters traceParameters, CancellationToken cancellationToken)
Parameters
Type Name Description
UtilityTraceParameters traceParameters

The input arguments to the trace.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken with which to cancel the operation if required.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<UtilityTraceResult>>

A task that represents the asynchronous trace operation on feature server. The value of the task result is System.Collections.Generic.IEnumerable<T>

Remarks

If the TraceType in UtilityTraceParameters is a subnetwork-based trace, it must have a UtilityDomainNetwork set in the UtilityTraceConfiguration returned from TraceConfiguration.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.12 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.2 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.12 - 200.7
Xamarin.Android100.12 - 100.14
Xamarin.iOS100.12 - 100.15
UWP100.12 - 200.7

TraceAsync(UtilityTraceParameters)

Asynchronously begins a trace with the supplied UtilityTraceParameters.

Declaration
public Task<IEnumerable<UtilityTraceResult>> TraceAsync(UtilityTraceParameters traceParameters)
Parameters
Type Name Description
UtilityTraceParameters traceParameters

The input arguments to the trace.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<UtilityTraceResult>>

A task that represents the asynchronous trace operation on feature server. The value of the task result is System.Collections.Generic.IEnumerable<T>

Remarks

If the TraceType in UtilityTraceParameters is a subnetwork-based trace, it must have a UtilityDomainNetwork set in the UtilityTraceConfiguration returned from TraceConfiguration.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.6 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.6 - 200.7
Xamarin.Android100.6 - 100.15
Xamarin.iOS100.6 - 100.15
UWP100.6 - 200.7
Relevant samples
Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
In This Article
Back to top Copyright © 2022 Esri.