PCMSGetFPARPOICategoryName
Syntax
int PCMSGetFPARPOICategoryName(PCMServerID serv, int poiCatIndex, char *buffer, int bufSize)
Parameters
- PCMServerID serv – The PC*Miler server ID.
- int poiCatIndex – Index of the POI category.
- char *buffer – Empty string buffer that will be filled with the name of the POI category.
- int bufSize – The number of bytes in the buffer.
Description
Gets the name of a specific Place of Interest (POI) category based on an index value when you find POIs along a route (FPAR).
The index starts at 0 with Custom Place Sets created in Content Tools and synced with PC*Miler. (If you have five Place Sets, those categories will occupy index Nos. 0-4). The remaining index numbers are generic Place categories in PC*Miler, including Rest Areas, Truck Stops, etc. Use PCMSGetNumFPARPOICategories
to get the total number of categories.
Return Values
A negative one (-1) indicates an error has occurred. Zero or greater indicates success and the number of characters put into the buffer.
Sample Code
memset(buffer, 0, BUFLEN);
PCMSGetFPARPOICategoryName(server, i, buffer, BUFLEN);
printf("%d %s", i, buffer);
Supported Since: PC*Miler Connect 29
Category: Find Places Along Route (FPAR)