Calling this method resets the object position to the given waypoint index. Usually, this is used to reset the object position to the beginning of the route (index = 0).
HRESULT RestartRoute(
[in, defaultvalue(0)] int Index)
Parameters:
Index – A zero based index of the waypoint that the object should start at.
Return Values:
The return value obtained from the returned HRESULT can be one of the following:
|
Return value |
Meaning |
|
S_OK |
Success. |
|
E_FAIL |
Catastrophic failure. |
|
TE_E_TEOBJECT_NOLONGEREXIST |
The object you are trying to access no longer exists. This may have occurred because, while keeping an interface to the object, the user deleted it from TerraExplorer (via the TE user interface). Without the object, the interface cannot be used. Therefore, you should release the interface. |
|
TE_E_INTERNAL |
TerraExplorer was unable to create the object. To get more information about this error use the IErrorInfo Interface. |