Difference between revisions of "Extensions.Xml.GetXmlRootElement"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetXmlRootElement'''}}Category:Xml == Classification == {{ClassificationActivity | GetXmlRootElement | UPDATING... | Term | Extensions.Xml|OTX...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetXmlRootElement'''}}[[Category:Xml]]
 
{{DISPLAYTITLE:OTX '''GetXmlRootElement'''}}[[Category:Xml]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetXmlRootElement | UPDATING... | [[Term]] | [[Extensions.Xml|OTX Xml extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetXmlRootElement|Returns the root element of an '''XML''' document.| [[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);
+
XmlElementTerm Xml.GetXmlRootElement(XmlDocumentTerm document);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
The '''GetXmlRootElement''' term returns the root element (root node) of an '''XML''' document.
−
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| [[Extensions.Xml.XmlElement|XmlElement]] | The root element of an '''XML''' document.}}
−
{{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| Document|[[Extensions.Xml.XmlDocument|XmlDocument]] | [[Term]] | - |[1..1]| The '''XmlDocument''' 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;
+
/// Local Declarations
 +
 
 +
Xml.XmlDocument XmlDocument1;
 +
Xml.XmlElement XmlElement1;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8);
−
// ...
+
XmlElement1 = Xml.GetXmlRootElement(XmlDocument1);
−
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/>

Latest revision as of 05:59, 8 November 2018

Classification

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

OTL Syntax

XmlElementTerm Xml.GetXmlRootElement(XmlDocumentTerm document);

Description

The GetXmlRootElement term returns the root element (root node) of an XML document.

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
XmlElement The root element of an XML document.

Properties

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

OTL Examples

/// Local Declarations

Xml.XmlDocument XmlDocument1;
Xml.XmlElement XmlElement1;

/// Flow

XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8);
XmlElement1 = Xml.GetXmlRootElement(XmlDocument1);

See also

CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementName
GetXmlElementsByXPath
GetXmlElementText
XmlFromByteField
XmlLoadFromFile
XmlToByteField

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Xml.GetXmlRootElement&oldid=9193"