AddStopOffPointsToFavorites()

static int CApplicationAPI::AddStopOffPointsToFavorites ( LpError  lpError, SPoi *  lpStopOffPoint, DWORD  dwMaxTime = DEFAULT_MAX_TIME  )

static

The function adds user defined POI to Favorites category.

Parameters

lpError	Additional error information returned from Drive.
lpStopOffPoint	Reference to instance of SPoi class which contains informations about POI to add.
dwMaxTime	Maximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.

Returns

1 if successful, other value otherwise.

To add custom POI to Favorites category fill in StopOffPoint members and call AddStopOffPointsToFavorites function. It is not necessary to call SetCategory function because POI category will be set to Favorites automatically.

See Coordinates conversion section in TROUBLESHOOTING page.

Possible error codes returned from Drive are:

• 0 - Function not succeeded.
• 1 - Function succeeded.
• 2 - Drive not succeeded.
• 3 - Function reached timeout.
• -1 - POI was not added because of invalid location syntax.