RemoveFavoriteFromList()

static int CApplicationAPI::RemoveFavoriteFromList ( LpError  lpError, SFavorite *  lpFavorite, DWORD  dwMaxTime = DEFAULT_MAX_TIME  )

static

The function removes POI from list of Favorites.

Parameters

lpError	Additional error information returned from Drive.
lpFavorite	Reference to instance of SPoi type which contains informations about POI to remove.
dwMaxTime	Maximum of 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 in Location and Name members of Favorite (see SPoi type).

Possible error codes returned from Drive are:

• 0 - Function not succeeded.
• 1 - Function succeeded.
• 2 - Drive not succeeded.
• 3 - Function reached timeout.
• -1 - Favorite was not removed because of invalid location syntax.
• -2 - Favorite was not removed because of missing Favorite with given name.