Skip to main content
Open topic with navigation CAPL Functions » ISO11783 » Virtual Terminal Interaction Layer (VT IL) » VTIL_BlockRxMessage

​
VTIL_BlockRxMessage

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long VTIL_BlockRxMessage(dword pgn, dword sourceAddress, qword filterMask, qword filterValue); // form 1
  • long VTIL_BlockRxMessage(dbNode node, dword pgn, dword sourceAddress, qword filterMask, qword filterValue); // form 2

​
Description

Prevents processing of a received message by the interaction layer. The message to block is specified by PGN, destination source address, and a part of the first eight data bytes. To revert this command you can use VTIL_ResetBlockedRxMessage or VTIL_ResetAllBlockedRxMessages.

​
Parameters

  • pgn: The message with this PGN shall be blocked.
  • sourceAddress:
    • 0 - 255: The message which is sent to this address shall be blocked.
    • 0xFFFFFFFF (-1): The source address of the message doesn’t matter.
  • filterMask: Defines the bits of the message which shall be used to identify the message.
  • filterValue: Defines the value of the bits of the message which shall be used to identify the message. If the value of the masked bits of a received message is equal to this value then the data of the message is blocked.
  • node: Simulation node to apply the function.

​
Return Values

  • 0: Manipulation is set successfully
  • -102: An invalid parameter is used

​
Example

—