Extensions.DiagCom.GetComParameterValueAsString
Jump to navigation
Jump to search
Contents
Classification
Name | GetComParameterValueAsString |
Short Description | The current value of a String communication parameter |
Class | Term |
Extension | OTX DiagCom extension |
Group | ComParam related terms |
Exceptions | UnknownTargetException TypeMismatchException |
Checker Rules | - |
Standard Compliant | Yes |
Pseudo-Code Syntax
String GetComParameterValueAsString(ComChannel comChannel, String comParameterName);
Description
The GetComParameterValueAsString term return the current value of a String communication parameter.
Return Value
The Term returns the value, see table below.
![]()
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
String | The current value of a String communication parameter. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
ComChannel | ComChannel | Term | - | [1] | Communication channel. |
ComParameterName | String | Term | - | [1] | Name of communication channel. |
Examples
String result = GetComParameterValueAsString(comChannel, "parameterName");
See also
GetComParameterValueAsBoolean
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity