OTX Reference  
OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey Class Reference

Gets the list parameter which represents the content of the STRUCTURE. More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey:
Inheritance graph

Public Attributes

DbParameterTerm dbParameter
 Cardinality [1]
The parameter to retrieve a List of Parameters which represents the content of the STRUCTURE referenced by the table row of the given key. More...
 
StringTerm key
 Cardinality [1]
The key to determine the table row which references the STRUCTURE. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData metaData
 Cardinality [0..1]
The MetaData type allows tools to store additional, mainly tool-specific data. More...
 

Detailed Description

Gets the list parameter which represents the content of the STRUCTURE.

The GetDbParameterStructureByKey term returns a List of Parameters which represents the content of the STRUCTURE referenced by the table row of the given key.

The length of the list is zero, if no MCDDbParameters is available. If the parameter is not of parameter type eTABLE_STRUCT, the InvalidTypeException exception will be thrown.

Note: The appropriate MVCI system operation is MCDDbParameter::getStructureByKey.

Exceptions
Exceptions.InvalidTypeExceptionIf the parameter is not of parameter type eTABLE_STRUCT.
Syntax
ListTerm = DiagDataBrowsingPlus.GetDbParameterStructureByKey(DbParameterTerm dbParameter, StringTerm key);
Examples
// Local Declarations
DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;
// Flow
[#MetaData(RequestPdu), <#Data>22 04 3E</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentCalibData"), {Param_RecorDataIdent = "Theftprotection Showroom Mode"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
List_DbParameter = DiagDataBrowsingPlus.GetDbParameterStructureByKey(DbParameter, "Theftprotection Showroom Mode");

Member Data Documentation

◆ dbParameter

DbParameterTerm OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey.dbParameter

Cardinality [1]
The parameter to retrieve a List of Parameters which represents the content of the STRUCTURE referenced by the table row of the given key.

◆ key

StringTerm OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey.key

Cardinality [1]
The key to determine the table row which references the STRUCTURE.

OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey.dbParameter
DbParameterTerm dbParameter
Cardinality [1] The parameter to retrieve a List of Parameters which represents the content of the ST...
Definition: DiagDataBrowsingPlus.cs:3707
OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Terms.GetDbParameterStructureByKey.key
StringTerm key
Cardinality [1] The key to determine the table row which references the STRUCTURE.
Definition: DiagDataBrowsingPlus.cs:3717