Difference between revisions of "Extensions.DiagCom.GetParameterTextId"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | GetParameterTextId | The text id of the parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | - | - }}
 
{{ClassificationActivity | GetParameterTextId | The text id of the parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String GetParameterTextId(Parameter parameter);
+
StringTerm = DiagCom.GetParameterTextId(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String parameterTextId = GetParameterTextId(parameter);
+
DiagCom.DiagService DiagService1;
 +
DiagCom.Parameter Parameter1;
 +
String TextId;
 +
DiagCom.ComChannel ComChannel1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_WheelDampeElectUDS", "EV_DRCONTITEMIC_001", false);
 +
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "SinglJob_FlashProgr");
 +
Parameter1 = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagService1), {"IPA_LogLevel"});
 +
TextId = DiagCom.GetParameterTextId(Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 03:03, 6 February 2015

Classification

Name GetParameterTextId
Short Description The text id of the parameter
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = DiagCom.GetParameterTextId(ParameterTerm);

Description

The GetParameterTextId term accepts a ParameterTerm and returns the text id of the Parameter.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String The text id of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The Parameter object.

OTL Examples

DiagCom.DiagService DiagService1;
DiagCom.Parameter Parameter1;
String TextId;
DiagCom.ComChannel ComChannel1;

ComChannel1 = DiagCom.GetComChannel("LL_WheelDampeElectUDS", "EV_DRCONTITEMIC_001", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "SinglJob_FlashProgr");
Parameter1 = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagService1), {"IPA_LogLevel"});
TextId = DiagCom.GetParameterTextId(Parameter1);

See also

GetParameterName
GetParameterSemantic
GetParameterByPath
GetParameterAsList
ExecuteDiagService