Syntax
int PCMSFindFuelStopsAlongRoute(Trip trip, float start, float end, bool bDistanceSearch, int sortOrder, float offRouteDistThreshold, const char *pFuelProviders)
Parameters
Trip trip – The handle of the trip to search for fuel stops. The trip must be run prior to executing the search.
float start – The starting point of the search window. This is either a distance in miles or time in minutes.
float end – The ending point of the search window. This is either a distance in miles or time in minutes.
bool bDistanceSearch – Tells whether the start and end points are distances or times. True = distances; False = time in minutes.
int sortOrder – Determines how the result list will be sorted.
0 = Distance from the trip’s origin.
1 = Drive time from the trip’s origin.
float offRouteDistThreshold – Sets the off route distance threshold to use when filtering the POI list. The default setting is 5 miles. If the user wants to keep the default value, set this parameter to zero or a negative number. Any value greater than zero will be accepted as the new off route distance threshold.
const char *pFuelProviders – A pipe (“|”) delimited string of fuel provider names used to filter the results list. Valid fuel provider names can be obtained by calling PCMSGetFuelProviders.
Description
Finds fuel stops along the route. The search is conducted within a user-specified window of distance or time along the route.
The search will filter the list by how far a fuel station is off the route. By default, only stations that are less than or equal to 5 miles off route will be included in the final result list (5 driven miles, not air miles.) This distance can be changed, and can be filtered by fuel provider name, if desired.
PCMSFindFuelStopsAlongRoute2 can be used to find stops within a specific leg of the route.
Note: Performance speed of this API can vary greatly depending on how wide you make the search window, how long the leg of the route is, and how dense the areas are that the route passes through.
Return Values
A negative one (-1) indicates an error has occurred. (Standard Failures)
Zero (0) indicates no POIs of the specified types were found within the start and end points along the route.
A positive value is the number of results found.
Supported Since: PC*MILER|Connect 29
Category: Find Places Along Route (FPAR)
