C++ SDK

◆ RemoveTMCEvent()

static int CApplicationAPI::RemoveTMCEvent ( LpError  lpError,
WORD  wTmcEventId,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

Removes a custom TMC event. Each custom event has an ID given to it by the navigation during creation.
However, TMC events should be defined so that they expire with their validity time.

Parameters
lpErrorAdditional error information returned from Drive.
wTmcEventIdThe ID of the TMC event returned by AddTMCEvent function.
dwMaxTimeMaximum 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.