Extensions.DiagDataBrowsingPlus.GetDbTableParameterKeyAsString
Jump to navigation
Jump to search
Contents
Classification
Name | GetDbTableParameterKeyAsString |
Short Description | Gets the value of the key of the DbParameter |
Class | Term |
Extension | OTX DiagDataBrowsingPlus extension |
Group | DbTable related terms |
Exceptions | InvalidTypeException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
StringTerm DiagDataBrowsingPlus.GetDbTableParameterKeyAsString(DbParameterTerm dbParameter);
Description
GetDbTableParameterKeyAsString returns the value of the key associated with the DbParameter in the corresponding DbTable (MCDDbTableParameter). If the DbParameter is not associated with a DbTable an empty string is returned.
If the parameter is not of data type eTABLE_ROW, the InvalidTypeException exception will be thrown.
The appropriate MVCI system operation is MCDDbTableParameter::getKey::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 |
String | Returns the value of the key associated with the DbParameter in the corresponding DbTable. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
DbParameter | DbParameter | Term | - | [1..1] | The element addresses the DbParameter (MCDDbTableParameter) which value of the key shall be returned. |
OTL Examples
/// Local Declarations
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
String MyString;
/// Flow
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_WriteFinge")), {"IPA_ProgrDate"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyString = DiagDataBrowsingPlus.GetDbTableParameterKeyAsString(DbParameter);
See also
GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter