Skip to main content

​
TestWaitForDiagChannelClosed

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long TestWaitForDiagChannelClosed(dword timeout_ms) // form 1
  • long TestWaitForDiagChannelClosed(char ecuQualifier[], dword timeout_ms); // form 2

​
Description

Waits for the occurrence of the state change of a diagnostic channel to the state Closed. Should the closing not occur before the expiration of the time timeout_ms, the wait condition is resolved nevertheless.

​
Parameters

  • timeout_ms: Maximum time that should be waited [ms]. Transmission of 0: no timeout controlling.
  • ecuQualifier: Qualifier of the ECU or target as set in the diagnostic configuration dialog for the respective diagnostic description.

​
Return Values

  • -2: Resume due to constraint violation
  • -1: General error, for example, functionality is not available
  • 0: Resume due to timeout
  • 1: Resume due to event occurred

​
Example

if (0 == DiagCloseChannel())
{
    TestStepPass(t"Channel close called successfully");
}
else
{
    TestStepFail("Call to channel close returned an error.");
}

if (1 == TestWaitForDiagChannelClosed(1000))
{
    TestStepPass("Channel closed successfully.");
}
else
{
    TestStepFail("Channel could not be closed.");
}
TestWaitForDiagChannelConnected