Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

XmlParser Template

build()

Build an XML tree from some XML source.

Syntax

XmlTag = rb.XmlParser.build(xmlData)

Parameters

The 'build' method takes 1 parameter:

Name Type/Value Range/Length Description
xmlDatastring  Required. A string containing the XML data to be parsed.

Results

The 'build' method returns XmlTag:

Type/Value Range/Length Description
XmlTag   If the file contains valid XML (according to the current mode of the parser) then the method returns the root node of the resulting XML tree. If the XML file is invalid then the method return 'null'. Errors will be available in the XmlParser.errors[] array.

Remarks

This method is used to create an XML tree from the string parameter. The parser takes the contents of the text string and attempts to build an internal tree representation of the contained XML. The rules used to build the tree may be modified by the XmlParser.mode() method.

The method only builds the XML tree (first stage of processing an XML document) - it does not execute that tree! To understand how the Whitebeam environment processes XML see the XML processing tutorial.

Whitebeam release 1.3.36
(loadtime : 28ms)