Extensions.DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption

From emotive
Jump to navigation Jump to search

Classification

Name GetDbSpecialDataGroupCaption
Short Description Gets the caption of the DbSpecialDataGroup
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbSpecialDataGroup related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption(DbSpecialDataGroupTerm specialDataGroup);

Description

GetDbSpecialDataGroupCaption returns the shortname of the MCDDbSpecialDataGroupCaption. If there is not caption available, an empty string is returned.

Icons Note.png The appropriate MVCI system operation is MCDDbSpecialDataGroup::getCaption

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 shortname of the MCDDbSpecialDataGroupCaption.

Properties

Name Data Type Class Default Cardinality Description
SpecialDataGroup DbSpecialDataGroup Term - [1..1] The element addresses the DbSpecialDataGroup (MCDDbSpecialDataGroup) which caption shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
String MyString;

/// Flow

[#MetaData(RequestPdu), <#Data>19 02 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByStatuMask"), {}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCode);
MyString = DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption(List_DbSpecialDataGroup[0]);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode
GetDbDiagServiceDbSpecialDataGroups
GetDbResponseDbSpecialDataGroups
GetDbRequestDbSpecialDataGroups
GetDbDiagTroubleCodeSpecialDataGroups