MapItineraryDistance (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

MapItineraryDistance (Function)

In french: CarteDistanceItinéraire

Calculates the distance of an itinerary in a Map control.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

sID is string = MapAddItinerary(CARTE_ChampCarte, ["Place de la comédie, Montpellier", ...
"Avenue des Champs Elysées, Paris"], itineraryCar)
rDist is real
rDist = MapItineraryDistance(CARTE_ChampCarte, sID)
LIB_DETAIL = "Distance: " + rDist / 1000.0 + " km"

Syntax

<Result> = MapItineraryDistance(<Map control> , <Itinerary identifier>)

<Result>: Real

Distance of the itinerary expressed in meters.
0 if a problem occurs (invalid identifier for example).

<Map control>: Control name

Name of the Map control to be used. If this parameter corresponds to an empty string (""), the Map control to which the current event belongs will be used.

<Itinerary identifier>: Character string

Identifier of the itinerary to use. This identifier corresponds to the result of the function MapAddItinerary.

Remarks

This function must not be called in the same process as the one used to display the itinerary. Indeed, the calculation is asynchronous. This function must be called once the itinerary is displayed (in the code of a calculation button for example).
The MapItineraryDistance function has no effect on manual routes.

Component: wd270obj.dll