Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbObjectDescription"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | StringTerm DiagDataBrowsingPlus.GetDbObjectDescription(DbObjectTerm dbObject); | |
| − | |||
| − | |||
| − | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 14: | Line 11: | ||
'''GetDbObjectDescription''' returns the Description of the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] which can also be empty (Description is not mandatory). | '''GetDbObjectDescription''' returns the Description of the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] which can also be empty (Description is not mandatory). | ||
| − | {{Note| | + | {{Note|The appropriate MVCI system operation is MCDNamedObject::getDescription}} |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the description of the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]].}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the description of the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]].}} | ||
| Line 21: | Line 18: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| | + | {{TableRowPropertie2| DbObject | [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | - | [1..1] |The element addresses the '''DbObject''' whose description shall be returned.}} |
|} | |} | ||
Latest revision as of 09:08, 2 November 2018
Contents
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 dbObject);Description
GetDbObjectDescription returns the Description of the DbObject which can also be empty (Description is not mandatory).
The appropriate MVCI system operation is MCDNamedObject::getDescription
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 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
/// Local Declarations
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
