RouteQuery Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Represents a route query object.
Inheritance Hierarchy
System..::.Object
Microsoft.Phone.Maps.Services..::.Query<(Of <(Route>)>)
Microsoft.Phone.Maps.Services..::.RouteQuery
Namespace: Microsoft.Phone.Maps.Services
Assembly: Microsoft.Phone.Maps (in Microsoft.Phone.Maps.dll)
Syntax
Public NotInheritable Class RouteQuery _
Inherits Query(Of Route)
public sealed class RouteQuery : Query<Route>
The RouteQuery type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
RouteQuery | Initializes a new instance of the RouteQuery class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
InitialHeadingInDegrees | Gets or sets the preferred start direction for the route from the current location. |
|
IsBusy | Gets a value that indicates whether the query is busy gathering results. (Inherited from Query<(Of <(T>)>).) |
|
RouteOptimization | Gets or sets the optimization to apply to the route. |
|
TravelMode | Gets or sets the mode of travel for the route. |
|
Waypoints | Gets or sets the start and end coordinates to route. |
Top
Methods
| Name | Description | |
|---|---|---|
|
CancelAsync | Cancels the query. (Inherited from Query<(Of <(T>)>).) |
.gif "Protected method") |
CheckThread | Checks if the current thread is on a UI thread. (Inherited from Query<(Of <(T>)>).) |
|
Dispose()()() | This API is not intended to be used directly from your code. (Inherited from Query<(Of <(T>)>).) |
|
Dispose(Boolean) | This API is not intended to be used directly from your code. (Inherited from Query<(Of <(T>)>).) |
|
DoCancelAsync | This API is not intended to be used directly from your code. (Inherited from Query<(Of <(T>)>).) |
|
DoStartAsync | This API is not intended to be used directly from your code. (Inherited from Query<(Of <(T>)>).) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Finalizes an instance of the Query<(Of <(T>)>) class. (Inherited from Query<(Of <(T>)>).) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnQueryCompleted | Called when the query completes running. (Inherited from Query<(Of <(T>)>).) |
|
QueryAsync | Starts the query. (Inherited from Query<(Of <(T>)>).) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
QueryCompleted | Occurs when the query completes running. (Inherited from Query<(Of <(T>)>).) |
Top
Remarks
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 |
EErrorRouteViolatesOptions |
Route was calculated but it violates options (ferries, toll roads, start direction, and so forth). |
0x80042321 |
EErrorRouteCorrupted |
Corrupted route. |
0x80042320 |
EErrorRouteNotReady |
Route not ready. |
0x8004231F |
EErrorRouteNotReadyFailedLocally |
Route not ready failed locally. |
0x8004231E |
EErrorRoutingCancelled |
Routing was cancelled. |
0x8004231C |
EErrorServerAuthorizationFailed |
Invalid credentials. For info about how to obtain the ApplicationId and AuthenticationToken, see How to add a Map control to a page in Windows Phone 8. |
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.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.