Skip to main content
Open topic with navigation CAPL Functions » Ethernet » Function Overview » EthernetMacsecSecureEntity::GetUseES

​
EthernetMacsecSecureEntity::GetUseES

Valid for: CANoe DE

​
Method Syntax

byte EthernetMacsecSecureEntity.GetUseES(byte& useES);

​
Description

Returns preset for the end station (ES) flag in the tag control information (TCI). When this bit is set, the recipient will assume the SCI can be formed from the frame’s source address and port number 1. When this bit is clear, and SC bit is also clear, the receiving secure channel cannot be determined from the frame’s contents. The secure entity will fall back to the default receive secure channel (see GetDefaultRxSC) for decoding the frame. Note that ES=1 and SC=1 is an invalid TCI setting.

​
Parameters

  • useES: The reference parameter where the queried value will be returned.

​
Return Values

  • byte: 1 if the call succeeded, 0 otherwise.

​
Example

—