Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbObjectDescriptionID"
Jump to navigation
Jump to search
| (3 intermediate revisions 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 | + | StringTerm DiagDataBrowsingPlus.GetDbObjectDescriptionID(DbObjectTerm dbObject); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 11: | ||
'''GetDbObjectDescriptionID''' returns the ID for the Description of the object as a [[Core.DataTypes.SimpleDataType.String|string]] which is made for multi language purposes. It returns the ID for a text in a texttable, in each language texttable the ID points to the same content but different language. The return value can be empty, if the ID can not be determined. | '''GetDbObjectDescriptionID''' returns the ID for the Description of the object as a [[Core.DataTypes.SimpleDataType.String|string]] which is made for multi language purposes. It returns the ID for a text in a texttable, in each language texttable the ID points to the same content but different language. The return value can be empty, if the ID can not be determined. | ||
| − | {{Note| | + | {{Note|The appropriate MVCI system operation is MCDDbObject::getDescriptionID}} |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the ID for the Description of the object}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the ID for the Description of the object}} | ||
| Line 18: | Line 18: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| | + | {{TableRowPropertie2| DbObject | [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | - | [1..1] |The element addresses the '''DbObject''' whose description ID shall be returned.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
String MyString; | String MyString; | ||
DiagDataBrowsingPlus.DbComChannel dbObject; | DiagDataBrowsingPlus.DbComChannel dbObject; | ||
Latest revision as of 09:07, 2 November 2018
Contents
Classification
| Name | GetDbObjectDescriptionID |
| Short Description | Gets the description ID of the DbObject |
| Class | Term |
| Extension | OTX DiagDataBrowsingPlus extension |
| Group | DbObject related terms |
| Exceptions | NONE |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
StringTerm DiagDataBrowsingPlus.GetDbObjectDescriptionID(DbObjectTerm dbObject);Description
GetDbObjectDescriptionID returns the ID for the Description of the object as a string which is made for multi language purposes. It returns the ID for a text in a texttable, in each language texttable the ID points to the same content but different language. The return value can be empty, if the ID can not be determined.
The appropriate MVCI system operation is MCDDbObject::getDescriptionID
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 ID for the Description of the object |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| DbObject | DbObject | Term | - | [1..1] | The element addresses the DbObject whose description ID shall be returned. |
OTL Examples
/// Local Declarations
String MyString;
DiagDataBrowsingPlus.DbComChannel dbObject;
/// Flow
dbObject = DiagDataBrowsingPlus.GetDbComChannel("EV_ACCBOSCHAU65X_001", "LL_AdaptCruisContrUDS");
MyString = DiagDataBrowsingPlus.GetDbObjectDescriptionID(dbObject);See also
GetDbComChannel
GetDiagServiceDbDiagService
GetParameterDbDiagTroubleCode
GetDbComChannelDbEnvDataDescs
GetDbComChannelDbFaultMemories
GetDbParameters
GetRequestDbRequest
GetResponseDbResponse
GetDbDiagServiceDbSpecialDataGroups
GetDbComChannelDbSubComponents
GetDbComChannelDbTables
