SError Struct Reference

SError class is used to obtain additional error informations after calling ApplicationAPI function. More...

#include <ApplicationApi.h>

Public Member Functions
	SError ()
	Constructor of SError. More...
int	GetCode ()
	The function returns error code. More...
LPCTSTR	GetDescription ()
	The function returns description of error code. More...
void	Clear ()
	The function clears message description. More...

Data Fields
int	nCode
	Error code. More...
TCHAR	szDescription [120]
	Description of error code. More...

Detailed Description

SError class is used to obtain additional error informations after calling ApplicationAPI function.

It is possible to get error code and error description by calling GetCode and GetDescription functions.
General error codes that sets each function are:

• 0 - Function not succeeded.
• 1 - Function succeeded.
• 2 - Drive not succeeded.
• 3 - Function reached timeout. Some functions gets also function-specific error codes:
• GetActualGpsPosition
  • -1 - No fix.
  • -2 - GPS position not available.
• AddStopOffPointsToFavorites
  • -1 - POI was not added because of invalid location syntax.
• RemoveFavoriteFromList
  • -1 - Favorite was not removed because of invalid location syntax.
  • -2 - Favorite was not removed because of missing Favorite with given name.
• AddPoi
  • -2 - POI was not added because of invalid location syntax.
• DeletePoi
  • -1 - POI was not deleted because of ambiguous location.
• GetLocationInfo
  • -1 - Location info was not found because of invalid location syntax.
• SetRoute
  • -3 - Navigation not started. Drive is already navigating.
  • -5 - User canceled route computing.
  • -6 - Drive is waiting for valid GPS signal.
  • -7 - Itinerary is empty
    • -8 - Itinerary has invalid format (from version 15j)
    • -9 - One or more waypoints were not found (from version 15j)
    • -10 - Itinerary was not found (from version 15j)
• StartNavigation and NavigateToAddress
  • -1 - Navigation not started because address was not found.
  • -3 - Navigation not started. Drive is already navigating.
  • -5 - User canceled route computing.
  • -6 - Drive is waiting for valid GPS signal.