C++ SDK

◆ DeletePoi()

static int CApplicationAPI::DeletePoi ( LpError  lpError,
SPoi lpPoi,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function deletes custom POI from custom category.

Parameters
lpErrorAdditional error information returned from Drive.
lpPoiReference to instance of SPoi type which contains POI to delete.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

It is necessary to fill Location and Name members of Poi (see SPoi type).
DeletePoi function deletes just item which has same value of Location and Name like taken Poi.

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 deleted because of ambiguous location.