C++ SDK

◆ GetPoiList()

static int CApplicationAPI::GetPoiList ( LpError  lpError,
SPoi *&  lstPoiArr,
int &  nSize,
LPCTSTR  lpszCategory,
BOOL  bSearchAddress,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function returns list of POIs from selected category.

Parameters
lpErrorAdditional error information returned from Drive.
lstPoiArrArray of SPoi which contains list of POIs after function execution.
nSizeSize of the lstPoiArr array.
strCategoryCategory name. It is name of category we want to retrieve list of POIs from.
bSearchAddressSpecify whether GetPoiList searches for address or not. If bSearchAddress=true GetPoiList fills address member of each PoiArr item (see SPoi type) with corresponding address.
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.