C++ SDK

◆ GetAddressList()

static int CApplicationAPI::GetAddressList ( LpError  lpError,
LPCTSTR  lpszAddress,
BOOL  bPostal,
int  nMaxCount,
SWayPoint *&  lpList,
int &  nCount,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function returns list of founded items from NameHierarchy.

Parameters
lpErrorAdditional error information returned from DriveMe.
lpszAddressAddress in format "Country,City/ ZIP,Street"
bPostalFlag determining whether City parameter represents city or ZIP code.
true - ZIP code.
false - City.
nMaxCountMaximum count of founded items.
lpListArray of SWayPoint which contains retrieved items.
nCountSize of the lpList array.
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.