ITMSFNCCustomDirections.GetQuery Method

Builds the provider query string for a directions request.

API unit family: TMSFNCDirections Declaring type: ITMSFNCCustomDirections

Syntax

FMX.TMSFNCDirections.hppPascalC++

function GetQuery(AOrigin, ADestination: string; AOriginLatitude, AOriginLongitude, ADestinationLatitude, ADestinationLongitude: Double; AAlternatives: Boolean = False; ATravelMode: TTMSFNCDirectionsTravelMode = tmDriving; AWayPointList: TStringList = nil; AWayPoints: TTMSFNCMapsCoordinateRecArray = nil; AOptimizeWayPoints: Boolean = False; ALocale: string = ''; AAvoidTolls: Boolean = False; AAvoidHighWays: Boolean = False): string;

virtual System::UnicodeString __fastcall GetQuery(System::UnicodeString AOrigin, System::UnicodeString ADestination, double AOriginLatitude, double AOriginLongitude, double ADestinationLatitude, double ADestinationLongitude, bool AAlternatives = false, TTMSFNCDirectionsTravelMode ATravelMode = (TTMSFNCDirectionsTravelMode)(0x0), System::Classes::TStringList* AWayPointList = (System::Classes::TStringList*)(0x0), TTMSFNCMapsCoordinateRecArray AWayPoints = TTMSFNCMapsCoordinateRecArray(), bool AOptimizeWayPoints = false, System::UnicodeString ALocale = System::UnicodeString(), bool AAvoidTolls = false, bool AAvoidHighWays = false) = 0;

Parameters

Name	Description
AOrigin	Origin address or coordinate for the route.
ADestination	Destination address or coordinate for the route.
AOriginLatitude	Latitude value for the coordinate.
AOriginLongitude	Longitude value for the coordinate.
ADestinationLatitude	Latitude value for the coordinate.
ADestinationLongitude	Longitude value for the coordinate.
AAlternatives	When True, alternative routes are requested when supported by the provider.
ATravelMode	Travel mode for the route request.
AWayPointList	Waypoint list or coordinate array included in the route request.
AWayPoints	Waypoint list or coordinate array included in the route request.
AOptimizeWayPoints	Waypoint list or coordinate array included in the route request.
ALocale	Locale used for provider instructions and responses.
AAvoidTolls	When True, toll roads are avoided when supported by the provider.
AAvoidHighWays	When True, highways are avoided when supported by the provider.

Returns

The request query string.