Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterLengthKey"

From emotive
Jump to navigation Jump to search
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DbParameterTerm = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm);
+
/// Local Declarations
 +
DiagDataBrowsingPlus.DbParameter DbParameterVariable;
 +
// Flow
 +
DbParameterVariable = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 25: Line 28:
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
DiagCom.Request Request;
 
DiagCom.Request Request;
 
DiagCom.Parameter Parameter;
 
DiagCom.Parameter Parameter;

Revision as of 07:02, 24 October 2018

Classification

Name GetDbParameterLengthKey
Short Description Gets the corresponding length key parameter of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
DiagDataBrowsingPlus.DbParameter DbParameterVariable;
// Flow
DbParameterVariable = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm);

Description

GetDbParameterLengthKey returns the corresponding request parameter with type eLENGTHKEY for this parameter with variable length.

If the parameter is not of variable length or no lengthkey can be determined, the InvalidTypeException exception will be thrown.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbParameter::getLengthKey

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
DbParameter Returns the corresponding length key parameter of the DbParameter.

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which corresponding length key parameter shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Request Request;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;

/// Flow

Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false), "DiagnServi_WriteMemorByAddreMCD20001"));
Parameter = DiagCom.GetParameterByPath(Request, {"Param_MemorAddre"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
DbParameter = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter