Extensions.ComInterface.GetComInterfaceNameList

From emotive
Jump to navigation Jump to search

Classification

Name GetComInterfaceNameList
Short Description returns the names (MCDInterface unique ShortNames) of the ComInterfaces with the given state as a ListTerm of String.
Class Term
Extension OTX ComInterface extension
Group ComInterface related Terms
Exceptions
Checker Rules
Standard Compliant Yes

OTL Syntax

ListTerm ComInterface.GetComInterfaceNameList(ConnectionStatusTerm connectionStatus);

Description

This term returns the names (MCDInterface unique ShortNames) of the ComInterfaces with the given state as a ListTerm of String. This call has no dependencies on the SelectProject and SelectVehicleInformation method. This call is independent of the selected project and selected vehicle information.

Icons Note.png The related MVCI system methods are MCDSystem::prepareVciAccessLayer(); MCDSystem::getCurrentInterfaces()

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
List The names (MCDInterface unique ShortNames) of the ComInterfaces with the given state as a ListTerm of String.

Properties

Name Data Type Class Default Cardinality Description
connectionStatus ConnectionStatus Term - [0..1] Represents the current state value that filters the returned interfaces.


See also

ActivateEthernet
CloseComInterface
ConnectComInterface
DeactivateEthernet
CreateComChannelFromComInterface
GetBatteryVoltageFromComInterface
GetComChannelFromComInterface
GetComInterface
GetComInterfaceNameListFromEthernet
GetComInterfaceProperties
GetComInterfaceResourceNameList
GetIgnitionStateFromComInterface
IsEthernetActivated
IsInterfaceConnected
GetDefaultComInterfaceName