Extensions.DiagCom.GetComParameterValueAsString
Contents
Classification
Name | GetComParameterValueAsString |
Short Description | Gets 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 |
OTL Syntax
StringTerm DiagCom.GetComParameterValueAsString(ComChannelTerm comChannel, StringTerm comParameterName);
Description
The GetComParameterValueAsString term will return the current value of a string type communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value will be returned.
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] | The ComChannelTerm specifies the ComChannel which will be queried. |
ComParameterName | String | Term | - | [1] | The otx:StringTerm specifies the name of a communication parameter. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
String String1 = "";
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
String1 = DiagCom.GetComParameterValueAsString(ComChannel1, "CP_ModifyTiming");
See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity