C# SDK

◆ RemoveFavoriteFromList()

static int RemoveFavoriteFromList ( out SError  Error,
SPoi  Favorite,
Int32  MaxTime 
)
inlinestatic

The function removes POI from list of Favorites.

Parameters
ErrorAdditional error information returned from Drive.
FavoriteReference to instance of SPoi class which contains informations about POI to remove.
MaxTimeMaximum of time (in milliseconds) function can take. If MaxTime=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 class).

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.

References SPoi.SizeOf(), and SError.SizeOf().