Skip to main content

​
TestWaitForEthernetLinkStatus

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long TestWaitForEthernetLinkStatus(long channel, long status, dword aTimeout); // form 1
  • long TestWaitForEthernetLinkStatus(long channel, Int64 hwChannel, long status, dword aTimeout); // form 2
  • long TestWaitForEthernetLinkStatus(ethernetport hwport, long status, dword aTimeout); // form 3

​
Description

Waits for the occurrence of the specified Ethernet link status. Should the Ethernet link status not occur before the expiration of the time aTimeout, the wait condition is resolved nevertheless. If the Ethernet link has already the expected state, the function returns immediately with return value 1.

​
Parameters

  • channel: Ethernet channel number.
    Value range: 1..32
  • hwChannel: Ethernet hardware channel number.
    Value range: 1..64
  • hwPort: Hardware port qualifier.
  • Status: Wait for this status:
    • 0 = link down
    • 1 = link up
  • aTimeout: Maximum time that should be waited [ms] (Transmission of 0: no timeout controlling).

​
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

void MainTest ()
{
  long result;
  dword timeout;
  ethernetport myEthernetPort;

  // form 1 - waits for link status up to occur on channel 1
  result = TestWaitForEthernetLinkStatus(1, 1, timeout);

  // form 2 - waits for link status up to occur on hardware channel 3 of channel 1
  result = TestWaitForEthernetLinkStatus(1, 3, 1, timeout);

  // form 3 - waits for link status down to occur on myEthernetPort;
  result = TestWaitForEthernetLinkStatus(myEthernetPort, 0, timeout);
}
TestJoinEthernetLinkStatus • ethGetLinkStatus • ethSetLinkStatus • on ethernetStatus