Syntax
int PCMSFindPOIsAlongRoute(Trip trip, float start, float end, bool bDistanceSearch, int sortOrder, float offRouteDistThreshold, const int *pPOITypes, int numPOITypes)
Parameters
Trip trip – The handle of the trip to execute the search along. The trip must be run prior to executing the search.
float start – The start point along the route for the search. The provided value may be either a distance in miles or time in minutes.
float end – The end point along the route for the search. The provided value may be either either a distance in miles or time in minutes.
bool bDistanceSearch – Tells whether the start and end points are distances or times. True = distances in decimal miles, False = time in decimal 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 PC*MILER setting of 5 miles is used when providing a zero or negative value.
const int* pPOITypes – An array of POI type index values to be included in the search. To get the index values, use PCMSGetNumFPARPOICategories and PCMSGetFPARPOICategoryName.
int numPOITypes – The number of POI types in the array.
Description
Finds Places of Interest (POIs) along the route. The search is conducted within a user-specified window of distance or time along the route. The type of POI searched for may also be filtered by providing a list of categories.
The search will filter the list by how far a POI is off the route. By default, only POIs that are less than or equal to 5 miles off route will be included in the final result list. (Five driven miles, not air miles.) This distance threshold can be changed.
PCMSFindPOIsAlongRoute2 can be used to find POIs that along a specified leg of a route.
Note: Performance speed of this API can vary greatly depending on how wide 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.
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)
