Extensions.ComInterface.CloseComInterface
Jump to navigation
Jump to search
Classification
| Name | CloseComInterface |
| Short Description | Closes the given interface regardless of whether it is the default interface or not |
| Class | Action |
| Extension | OTX ComInterface extension |
| Group | ComInterface related Actions |
| Exceptions | InvalidReferenceException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ActionRealisation ComInterface.CloseComInterface(ComInterfaceVariable comInterface);
Description
The CloseComInterface action is called when the diagnostic application has finished its diagnostic communication via a selected interface. This action closes the given interface regardless of whether it is the default interface or not.
CloseComInterface has no influence on the ethernet activation state!
Please note that the use of the CloseComInterface action by an OTX sequence only indicates that the interface is not needed any more – it is up to the implementation of a specific runtime system whether it actually frees all resources and closes the interface at this point or not.
The appropriate MVCI system operation is MCDInterface::disconnect().
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| comInterface | ComInterface | Variable | - | [1..1] | Represents the handle of the communication interface which should be closed. |
OTL Examples
/// Local Declarations
ComInterface.ComInterface ComInterface1;
Exception Exception1;
/// Flow
ComInterface.ConnectComInterface(ComInterface1);
try
{
ComInterface.CloseComInterface(ComInterface1);
}
catch (InvalidReferenceException Exception1)
{
}
