RouteQuery Class

May 11, 2014

Represents a route query object.

System.Object
  Microsoft.Phone.Maps.Services.Query<Route>
    Microsoft.Phone.Maps.Services.RouteQuery

Namespace:  Microsoft.Phone.Maps.Services
Assembly:  Microsoft.Phone.Maps (in Microsoft.Phone.Maps.dll)

public sealed class RouteQuery : Query<Route>

The RouteQuery type exposes the following members.

  NameDescription
Public methodRouteQueryInitializes a new instance of the RouteQuery class.
Top

  NameDescription
Public propertyInitialHeadingInDegreesGets or sets the preferred start direction for the route from the current location.
Public propertyIsBusyGets a value that indicates whether the query is busy gathering results. (Inherited from Query<T>.)
Public propertyRouteOptimizationGets or sets the optimization to apply to the route.
Public propertyTravelModeGets or sets the mode of travel for the route.
Public propertyWaypointsGets or sets the start and end coordinates to route.
Top

  NameDescription
Public methodCancelAsyncCancels the query. (Inherited from Query<T>.)
Protected methodCheckThreadChecks if the current thread is on a UI thread. (Inherited from Query<T>.)
Public methodDispose()This API is not intended to be used directly from your code. (Inherited from Query<T>.)
Protected methodDispose(Boolean)This API is not intended to be used directly from your code. (Inherited from Query<T>.)
Protected methodDoCancelAsyncThis API is not intended to be used directly from your code. (Inherited from Query<T>.)
Protected methodDoStartAsyncThis API is not intended to be used directly from your code. (Inherited from Query<T>.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeFinalizes an instance of the Query<T> class. (Inherited from Query<T>.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnQueryCompletedCalled when the query completes running. (Inherited from Query<T>.)
Public methodQueryAsyncStarts the query. (Inherited from Query<T>.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventQueryCompletedOccurs when the query completes running. (Inherited from Query<T>.)
Top

The following error codes can be returned in the HResult property of the Error property of the QueryCompletedEventArgs (e.Error.HResult) when you run a RouteQuery.

HResult

Symbolic Code

Description

0x80042328

EErrorGraphDisconnected

No route found.

0x80042327

EErrorGraphDisconnectedCheckOptions

No route found, some option(for example disabled highways) may be prohibiting it.

0x80042326

EErrorNoStartPoint

Start point not found.

0x80042325

EErrorNoEndPoint

End point not found.

0x80042324

EErrorNoEndPointCheckOptions

End point unreachable, some option (for example disabled highways) may be prohibiting it.

0x80042323

EErrorCannotDoPedestrian

Pedestrian mode was set, but cannot do pedestrian route (too long route).

0x80042322

EErrorRouteUsesDisabledRoads

Route was calculated but it uses roads, which were disabled by options, note: this error is given also when start direction is violated.

0x80042321

EErrorRouteCorrupted

Corrupted route.

0x80042320

EErrorRouteNotReady

Route not ready.

0x8004231F

EErrorRouteNotReadyFailedLocally

Route not ready failed locally.

0x8004231E

EErrorRoutingCancelled

Routing was cancelled.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_MAP

Windows Phone 8

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft