C++ SDK

◆ HighlightPoi()

static int CApplicationAPI::HighlightPoi ( LpError  lpError,
LPCTSTR  lpszPoiCategory,
LPCTSTR  lpszPoiName,
LPCTSTR  lpszSound,
LONGPOSITION  cpPoiLocation,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

Highlight the POI.

Parameters
lpErrorAdditional error information returned from Drive.
lpszPoiCategoryUser defined POI category name
lpszPoiNamePOI name
lpszSoundSound to play when Highlight POI
cpPoiLocationPosition of POI
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.