Extensions.ComInterface.GetComInterface
Jump to navigation
Jump to search
Classification
| Name | GetComInterface |
| Short Description | Returns the ComInterface for the given name. |
| Class | Term |
| Extension | OTX ComInterface extension |
| Group | ComInterface related Terms |
| Exceptions | UnknownTargetException |
| Checker Rules | |
| Standard Compliant | Yes |
OTL Syntax
ComInterfaceTerm ComInterface.GetComChannel(StringTerm comInterfaceName);
Description
Returns the ComInterface for the given name. ComInterface can only delivered for a ComInterface, which is included in the current interface list.
The appropriate MVCI system operation is MCDsystem::getCurrentInterfaces::getItemByName().
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| ComInterface | The ComInterface for the given name. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| conInterfaceName | String | Term | - | [1..1] | The unique name (ID) of the interface which defines it. |
