Extensions.ComInterface.GetComInterfaceNameListFromEthernet

Classification

Name	GetComInterfaceNameListFromEthernet
Short Description	Return the names (MCDInterface unique ShortNames) of the ComInterfaces 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.GetComInterfaceNameListFromEthernet(ComInterfaceTerm comInterface, StringTerm optionString);

Description

This term returns the names (MCDInterface unique ShortNames) of the ComInterfaces as a ListTerm of String.

The appropriate MVCI system operation is MCDInterface::detectInterfaces().

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
List	The names (MCDInterface unique ShortNames) of the ComInterfaces as a ListTerm of String.

Properties

Name	Data Type	Class	Default	Cardinality	Description
comInterface	ComInterface	Term	-	[0..1]	This optional element allows as input a ComInterface with an ethernet activation pin on.
optionString	String	Term	-	[1..1]	The OptionString element sets the configuration of the base system that is needed to get interfaces. It is specified in the MCD specification. If no option is entered the configuration of the base system is used. The MVCI server supports DoIP interface detection. The VCI access layer has been prepared by calling prepareVciAccessLayer. The input parameter "optionString" has the following format: --OptStringFmt ::= PDU_IOCTL='PDU_IOCTL_VEHICLE_ID_REQUEST' [] PSM ::= PreselectionMode= PreselectionMode ::= 'None' | 'VIN' | 'EID' PSV ::= PreselectionValue= PreselectionValue ::= 'string' // containing an optional VIN or an EID to preselect // detection of DoIP entities, depending on parameter // "PreselectionMode". This string is left empty if no // preselection is desired (PreselectionMode='None'). CM ::= CombinationMode= CombinationMode ::= 'DoIP-Entity' | 'DoIP-Vehicle' | 'DoIP-Group' | 'DoIP-Collection' VDT::= VehicleDiscoveryTime= VehicleDiscoveryTime ::= 'unsigned short' // Time-out to wait forISO/IEC 13209-4:2016(E) © ISO/IEC 2016 – All rights reserved 55 vehicle identification responses. // 0=return immediately, or time in milliseconds. DAC ::= DestinationAddressCount= DestinationAddressCount ::= 'unsigned short' // No. of broadcast/multicast addresses in the destination // address list DAList. In case of an empty list, the // sequence is omitted. DAList ::= (DA='' | '')+ n ::= // current number starting with 1, maximum value // according to DestinationAddressCount IPv4 ::= // dottet decimal notation, e.g. 192.168.1.255 IPv6 ::= // hexadecimal, colon separated according to // RFC4291, section 2.2 sep ::= blank

See also

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