Skip to main content

​
TestWaitForMostAMSSpyMessage

Valid for: CANoe DE

​
Function Syntax

  • long TestWaitForMostAMSSpyMessage(dbMsg aDBMsg, int aInstanceId, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aFBlockId, int aInstanceId, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aFBlockId, int aInstanceId, int aFunctionId, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aFBlockId, int aInstanceId, int aFunctionId, int aOpType, dword aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aSourceAddress, int aDestinationAddress, int aFBlockId, int aInstanceId, int aFunctionId, int aOpType, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aSourceAddress, int aDestinationAddress, char[] aSymbolicMessage, int aInstanceId, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(int aSourceAddress, int aDestinationAddress, char[] aSymbolicMessage, unsigned long aTimeout);
  • long TestWaitForMostAMSSpyMessage(char[] aSymbolicMessage, int aInstanceId, unsigned long aTimeout);
  • TestWaitForMostAMSSpyMessage(char[] aSymbolicMessage, unsigned long aTimeout);

​
Description

Waits for the occurrence of the specified MOST AMS spy message. This may deal with transmission of individual frames (TelID=0) or segmented transmissions. In the case of segmented transmission, the last control message of a correct transmission resolves the wait conditions. If the message does not occur by the time the aTimeout expires, the wait condition is still resolved. 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

  • aDBMsg: MOST function catalog MOST message (e.g. AudioDiskPlayer.TrackPosition.Status) or message name from CANdb database (e.g. ADP_TrackPosition_Status).
  • aSourceAddress: Source address
  • aDestinationAddress: Target address
  • aFBlockId: Numeric value of FBlockID
  • aInstanceId: Numeric value of InstanceID
  • aFunctionId: Numeric value of FunctionID
  • aOpType: Numeric value of OpTypes
  • aTimeout: Maximum time that should be waited [ms] (Transmission of 0: no timeout monitoring; test module waits infinitely long)
  • aSymbolicMessage: Symbolic MOST message definition in one of the following formats:
    • FBlock.InstanceId.Function.OpType(Parameterliste)
    • FBlock.InstanceId.Function.OpType
    • FBlock.Function.OpType(Parameterliste)
    • FBlock.Function
    • FBlock
(See also Symbolic definition of MOST messages)

​
Return Values

  • -6: Parse Error; on specification of a symbolic message definition that cannot be resolved with the available XML function catalog or that is flawed
  • -2: Resume based on Constraint Violation
  • -1: General error e.g. the functionality is not available
  • 0: Resume based on Timeout
  • 1: Resume based on occurred event

​
Example

— TestWaitForMostSpyMessage • TestWaitForMostAMSMessage • TestJoinMostAMSSpyMessageEvent • TestWaitForMostAMSSpyReport • TestGetWaitEventMostAMSMsgData • Symbolic definition of MOST messages • Input assistance