Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbObjectDescription"

From emotive
Jump to navigation Jump to search
Line 18: Line 18:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie2| dbObject | [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] whose description shall be returned.}}
+
{{TableRowPropertie2| dbObject | [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] whose description shall be returned.}}
 
|}
 
|}
  

Revision as of 07:07, 12 September 2018

Classification

Name GetDbObjectDescription
Short Description Gets the description of the DbObject
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbObject related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbObjectDescription(DbObjectTerm);

Description

GetDbObjectDescription returns the Description of the DbObject which can also be empty (Description is not mandatory).

Icons Note.png NOTE — The appropriate MVCI system operation is MCDNamedObject::getDescription

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 description of the DbObject.

Properties

Name Data Type Class Default Cardinality Description
dbObject DbObject Term - [1..1] The element addresses the DbObject whose description shall be returned.

OTL Examples

String MyString;
DiagDataBrowsingPlus.DbComChannel dbObject;

/// Flow

dbObject = DiagDataBrowsingPlus.GetDbComChannel("EV_ACCBOSCHAU65X_001", "LL_AdaptCruisContrUDS");
MyString = DiagDataBrowsingPlus.GetDbObjectDescription(dbObject);

See also

GetDbComChannel
GetDiagServiceDbDiagService
GetParameterDbDiagTroubleCode
GetDbComChannelDbEnvDataDescs
GetDbComChannelDbFaultMemories
GetDbParameters
GetRequestDbRequest
GetResponseDbResponse
GetDbDiagServiceDbSpecialDataGroups
GetDbComChannelDbSubComponents
GetDbComChannelDbTables