PCMSMatrixSetMaxAirMiles

Syntax

int PCMSMatrixSetMaxAirMiles (long airMiles)

Parameters

long airMiles – The air miles threshold between two stops.

Description

Specifies a maximum air distance to be used by PCMSMatrixCalculate to decide whether it needs to calculate a distance between two stops. If two stops are farther apart than this air distance, then no distance for that pair will be calculated, and a negative number will be stored in the output matrix. By default, this value is set at 1,500 miles.

Return Values

Negative one (-1) indicates that the product is not licensed for RouteMatrix.

Sample Code

if (airMiles > 0)
  PCMSMatrixSetMaxAirMiles(airMiles);

Supported Since: PC*Miler Connect 26

Category: Matrix Functions