Extensions.ComInterface.GetDefaultComInterfaceName

From emotive
Jump to navigation Jump to search

Classification

Name GetDefaultComInterfaceName
Short Description Returns the name (MCDInterface unique LongName) of the default ComInterface with the MCDInterfaceStatus READY state as a String.
Class Term
Extension OTX ComInterface extension
Group ComInterface related Terms
Exceptions NoDefaultComInterfaceException
Checker Rules
Standard Compliant Yes

OTL Syntax

StringTerm ComInterface.GetDefaultComInterfaceName();

Description

Returns the name of the default ComInterface.
This term returns the name (MCDInterface unique LongName) of the default ComInterface with the MCDInterfaceStatus READY state as a String. This call has no dependencies on the SelectProject and SelectVehicleInformation method. This call is independent of the selected project and selected vehicle information.
Returns a string with the MCDInterface unique LongName.

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
String The name of the default ComInterface.


See also

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