Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeTextId

From emotive
Jump to navigation Jump to search

Classification

Name GetDbDiagTroubleCodeTextId
Short Description Gets the Text Id of the DbDiagTroubleCode
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagTroubleCode related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbDiagTroubleCodeTextId(DbDiagTroubleCodeTerm dbDiagTroubleCode);

Description

GetDbDiagTroubleCodeTextId returns the text id of the DbDiagTroubleCode from ODX as string. If the TextID cannot be obtained from ODX, an empty string is returned. There are two different text IDs in ODX, one in the SHORTLABEL and one in the VT. Only the text ID of the VT will be considered. The returned value represents the TI of the physical value as selected by the server. For a request parameter, the text ID may be empty in case no valid text ID can be determined.

Icons Note.png The appropriate MVCI system operation is MCDDbDiagTroubleCode::getDiagTroubleCodeTextID

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
String Returns the text id of the DbDiagTroubleCode from ODX.

Properties

Name Data Type Class Default Cardinality Description
DbDiagTroubleCode DbDiagTroubleCode Term - [1..1] The element addresses the DbDiagTroubleCode (MCDDbDiagTroubleCode) which text id shall be returned.

OTL Examples

/// Local Declarations

String MyString;
DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;

/// Flow

[#MetaData(RequestPdu), <#Data>19 02 0C</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByConfiAndPendiStatu"), {}, {Resp_ReadDTCInforReporDTCByStatuMask.Expected = true}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
MyString = DiagDataBrowsingPlus.GetDbDiagTroubleCodeTextId(DbDiagTroubleCode);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode