Skip to main content

​
TestWaitForMostLightOff

Valid for: CANoe DE

​
Function Syntax

long TestWaitForMostLightOff(dword aTimeout);

​
Description

The function waits until the expiration of the time aTimeout for the occurrence of a LightLock event indicating “no Light & no Lock” state. A LightLock event with a “no Light & no Lock” state is generated when the hardware connected to the channel no longer receives light at the Fiber Optical Receiver (FOR). Note: Consider to set always the appropriate bus context in a multibus environment before the function is called. Further information on site MultiBus Environment.

​
Parameters

  • aTimeout: Maximum wait time [ms] (Specification of 0: no timeout controlling)

​
Return Values

  • -2: Resume due to constraint violation
  • -1: General error, e.g., functionality is not available
  • 0: Resume due to timeout
  • 1: Resume based on occurred event

​
Example

— TestWaitForMostCriticalUnlock • TestWaitForMostShortUnlock • TestWaitForMostStableLock