GetFavoritesList()

static int CApplicationAPI::GetFavoritesList ( LpError  lpError, SFavorite *&  lstFavoriteArr, int &  nSize, BOOL  bSearchAddress, DWORD  dwMaxTime = DEFAULT_MAX_TIME  )

static

The function returns list of POIs in Favorites category.

Parameters

lpError	Additional error information returned from Drive.
lstFavoriteArr	After function execution lstFavoriteArr contains list of retrieved favorites.
nSize	Size of the lstFavoriteArr
bSearchAddress	Specifies whether GetFavoritesList function searches for address or not. If bSearchAddress=true GetFavoritesList fills address member of each lstFavoriteArr item (see SPoi type) with corresponding address.
dwMaxTime	Maximum 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.