Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsString"
Jump to navigation
Jump to search
Line 9: | Line 9: | ||
== Description == | == Description == | ||
− | The '''GetDefaultComParameterValueAsString''' term | + | The '''GetDefaultComParameterValueAsString''' term will return the default value of a [[Core.DataTypes.SimpleDataType.String|string]] type communication parameter. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The default value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The default value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}} |
Latest revision as of 04:17, 26 December 2019
Contents
Classification
Name | GetDefaultComParameterValueAsString |
Short Description | Gets The default 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.GetDefaultComParameterValueAsString(ComChannelTerm comChannel, StringTerm comParameterName);
Description
The GetDefaultComParameterValueAsString term will return the default value of a string type 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 default 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);
String1 = DiagCom.GetDefaultComParameterValueAsString(ComChannel1, "CP_ModifyTiming");
See also
GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity