# null

# TestJoinMostSpyMessageEvent

[Valid for](../../../Shared/FeatureAvailability.md): CANoe DE

## Function Syntax

* `TestJoinMostSpyMessageEvent(dbMsg aDBMsg, int aInstanceId)`
* `TestJoinMostSpyMessageEvent(int aFBlockId, int aInstanceId)`
* `TestJoinMostSpyMessageEvent(int aFBlockId, int aInstanceId, int aFunctionId)`
* `TestJoinMostSpyMessageEvent(int aFBlockId, int aInstanceId, int aFunctionId, int aOpType)`
* `TestJoinMostSpyMessageEvent(int aSourceAddress, int aDestinationAddress, int aFBlockId, int aInstanceId, int aFunctionId, int aOpType)`
* `TestJoinMostSpyMessageEvent(int aSourceAddress, int aDestinationAddress, char[] aSymbolicMessage, int aInstanceId)`
* `TestJoinMostSpyMessageEvent(int aSourceAddress, int aDestinationAddress, char[] aSymbolicMessage)`
* `TestJoinMostSpyMessageEvent(char[] aSymbolicMessage, int aInstanceId)`
* `TestJoinMostSpyMessageEvent(char[] aSymbolicMessage)`

## Description

Completes the current set of "joined events" with the transmitted event, a MOST Spy message.

The first arriving control message, which fulfills the specified conditions, resolves the wait point, irregardless of whether it is part of a segmented transmission. TelId is not included in this process.

This function does not wait.

The wait point can be subsequently attached with [TestWaitForAllJoinedEvents](CAPLfunctionTestWaitForAllJoinedEvents.md) and [TestWaitForAnyJoinedEvent](CAPLfunctionTestWaitForAnyJoinedEvent.md).

**Note**: Consider to set always the appropriate bus context in a multibus environment before the function is called. Further information on site [MultiBus Environment](../../../Shared/CAPL/General/TestMultiBusEnvironment.md).

## 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
* **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](../CAPLfunctionsTFSSymbolicMessageDefinition.md))

**Note**: For parameters `aSourceAddress`, `aDestinationAddress`, `aFBlockId`, `aInstanceId`, `aFunctionId` and `aOpType` the following applies: If `-1` is given, the corresponding field can get any value. This is also the standard for not explicit set values.

## 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
* **-3**: Join error
* **-1**: General error e.g. the functionality is not available
* **> 0**: Number of joined events

## Example

—

[TestWaitForAllJoinedEvents](CAPLfunctionTestWaitForAllJoinedEvents.md) • [TestWaitForAnyJoinedEvent](CAPLfunctionTestWaitForAnyJoinedEvent.md) • [TestJoinMostMessageEvent](CAPLfunctionTestJoinMostMessageEvent.md) • [TestJoinMostSpyReportEvent](CAPLfunctionTestJoinMostSpyReportEvent.md) • [TestJoinMostAMSSpyMessageEvent](CAPLfunctionTestJoinMostAMSSpyMessageEvent.md) • [TestWaitForMostSpyMessage](CAPLfunctionTestWaitForMostSpyMessage.md) • [TestGetWaitEventMostMsgData](CAPLfunctionTestGetWaitEventMostMsgData.md)
