GetFavoritesList()

static int GetFavoritesList ( out SError  Error, out SPoi []  FavoriteArr, bool  bSearchAddress, Int32  MaxTime  )

inlinestatic

The function returns list of POIs in Favorites category.

Parameters

Error	Additional error information returned from Drive.
FavoriteArr	After function execution FavoriteArr contains list of retrieved favorites.
bSearchAddress	Specifies whether GetFavoritesList function searches for address or not. If bSearchAddress=true GetFavoritesList fills address member of each FavoriteArr item (see SPoi class) with corresponding address.
MaxTime	Maximum time (in milliseconds) function can take. If MaxTime=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.

References SError.SizeOf().