Extensions.DiagDataBrowsingPlus.GetDbParameterKeysAsString
Jump to navigation
Jump to search
Contents
Classification
Name | GetDbParameterKeysAsString |
Short Description | Gets the table key of the DbParameter |
Class | Term |
Extension | OTX DiagDataBrowsingPlus extension |
Group | DbParameter related terms |
Exceptions | InvalidTypeException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
ListTerm DiagDataBrowsingPlus.GetDbParameterKeysAsString(DbParameterTerm dbParameter);
Description
GetDbParameterKeysAsString returns a list of strings. If the corresponding TABLE-KEY references a TABLE (dynamic case), this method delivers all keys of this TABLE (keys of all TABLE-ROWs). If the corresponding TABLE-KEY references a TABLE-ROW directly (static case), this method delivers exactly one key – the key of that TABLEROW. The length of the list is zero, if no Key is available.
If the parameter is not of parameter type eTABLE_KEY, the InvalidTypeException exception will be thrown.
The appropriate MVCI system operation is MCDDbParameter::getKeys[]::getValueAsString
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 all keys of the table key. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
DbParameter | DbParameter | Term | - | [1..1] | The element addresses the DbParameter (MCDDbParameter) which table key shall be returned. |
OTL Examples
/// Local Declarations
DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<String> List_String;
/// Flow
[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_RecorDataIdent"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
List_String = DiagDataBrowsingPlus.GetDbParameterKeysAsString(DbParameter);
See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter