Difference between revisions of "Extensions.Xml.GetXmlElementName"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetXmlElementName'''}}Category:Xml == Classification == {{ClassificationActivity | GetXmlElementName | UPDATING... | Term | Extensions.Xml|OTX...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetXmlElementName'''}}[[Category:Xml]]
 
{{DISPLAYTITLE:OTX '''GetXmlElementName'''}}[[Category:Xml]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetXmlElementName | UPDATING... | [[Term]] | [[Extensions.Xml|OTX Xml extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetXmlElementName|Returns the name of an XML element| [[Term]] | [[Extensions.Xml|OTX Xml extension]] |[[Extensions.Xml#Terms|Xml related Terms]] | - | - |}}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.CloseComChannel(ComChannelVariable);
+
StringTerm = Xml.GetXmlElementName(XmlElementTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
The '''GetXmlElementName''' term returns the name of an '''XML''' element as a String. The value can contain an arbitrary namespace in form of "Prefix:Name".
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
{{ComChannelMemoryUsageNote}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The name of an '''XML''' element}}
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
 
-->
 
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| Element|[[Extensions.Xml.XmlElement|XmlElement]] | [[Term]] | - |[1..1]| The '''XmlElement''' object, to which the operation is applied.}}
 
|}
 
|}
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.ComChannel myComCannel;
+
Xml.XmlElement XmlElement1;
 +
String String1 = "";
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
XmlElement1 = Xml.CreateXmlElement("root", "abc");
// ...
+
String1 = Xml.GetXmlElementName(XmlElement1);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.Xml.CopyXmlElement|CopyXmlElement]]<br/>
 +
[[Extensions.Xml.CreateXmlDocument|CreateXmlDocument]]<br/>
 +
[[Extensions.Xml.CreateXmlElement|CreateXmlElement]]<br/>
 +
[[Extensions.Xml.GetXmlElementAttributes|GetXmlElementAttributes]]<br/>
 +
[[Extensions.Xml.GetXmlElementChildElements|GetXmlElementChildElements]]<br/>
 +
<!--[[Extensions.Xml.GetXmlElementName|GetXmlElementName]]<br/>-->
 +
[[Extensions.Xml.GetXmlElementsByXPath|GetXmlElementsByXPath]]<br/>
 +
[[Extensions.Xml.GetXmlElementText|GetXmlElementText]]<br/>
 +
[[Extensions.Xml.GetXmlRootElement|GetXmlRootElement]]<br/>
 +
[[Extensions.Xml.XmlFromByteField|XmlFromByteField]]<br/>
 +
[[Extensions.Xml.XmlLoadFromFile|XmlLoadFromFile]]<br/>
 +
[[Extensions.Xml.XmlToByteField|XmlToByteField]]<br/>

Revision as of 08:56, 9 October 2018

Classification

Name GetXmlElementName
Short Description Returns the name of an XML element
Class Term
Extension OTX Xml extension
Group Xml related Terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = Xml.GetXmlElementName(XmlElementTerm);

Description

The GetXmlElementName term returns the name of an XML element as a String. The value can contain an arbitrary namespace in form of "Prefix:Name".

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 The name of an XML element

Properties

Name Data Type Class Default Cardinality Description
Element XmlElement Term - [1..1] The XmlElement object, to which the operation is applied.

OTL Examples

Xml.XmlElement XmlElement1;
String String1 = "";

/// Flow

XmlElement1 = Xml.CreateXmlElement("root", "abc");
String1 = Xml.GetXmlElementName(XmlElement1);

See also

CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementsByXPath
GetXmlElementText
GetXmlRootElement
XmlFromByteField
XmlLoadFromFile
XmlToByteField