MapRouteDrivingOptions.AlternateRouteCount | alternateRouteCount property

[This documentation is preliminary and is subject to change.]

Gets or sets a value that indicates how many alternative routes are to be provided, if available.

Syntax

var alternateRouteCount = mapRouteDrivingOptions.alternateRouteCount;
mapRouteDrivingOptions.alternateRouteCount = alternateRouteCount;
public uint AlternateRouteCount { get; set; }
Public Property AlternateRouteCount As UInteger
public:
property unsigned int AlternateRouteCount { 
   unsigned int get();
   void set (unsigned int value);
}

Property value

Type: Number [JavaScript] | System.UInt32 [.NET] | uint32 [C++]

The number of alternative routes that are to be provided, if available.

Remarks

When AlternateRouteCount is set to 1 or greater, the GetDrivingRouteAsync method will provide additional routes between the same start and end points (when available).

Note  Some alternative routes may violate route restrictions. Use the ViolatedRestrictions property to check for violations.

Requirements (device family)

Device family

Universal

API contract

windows.foundation.universalapicontract, introduced version 1.0

Namespace

Windows.Services.Maps Windows::Services::Maps [C++]

Metadata

windows.foundation.universalapicontract.winmd

See also

MapRouteDrivingOptions