Extensions.DiagDataBrowsingPlus.GetDbParameterStructureByKey

Classification

Name	GetDbParameterStructureByKey
Short Description	Gets the content of the related structure of the DbParameter
Class	Term
Extension	OTX DiagDataBrowsingPlus extension
Group	DbParameter related terms
Exceptions	InvalidTypeException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbParameterStructureByKey(DbParameterTerm dbParameter, StringTerm key);

Description

GetDbParameterStructureByKey returns a list of DbParameter whose 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.

The appropriate MVCI system operation is MCDDbParameter::getStructureByKey

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
List	Returns a list of DbParameter whose represents the content of the STRUCTURE referenced by the table row of the given key.

Properties

Name	Data Type	Class	Default	Cardinality	Description
DbParameter	DbParameter	Term	-	[1..1]	The element addresses the DbParameter (MCDDbParameter) which content of the related structure shall be returned.
Key	String	Term	-	[1..1]	The key addresses the table row of the DbParameter of type eTABLE_STRUCT.

OTL 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");

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter