XML.load()

XML.load()

Availability

Flash Player 5; behavior changed in Flash Player 7.

Usage

my_xml.load(url)

Parameters

url The URL where the XML document to be loaded is located. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file; for details, see "Description," below.

Returns

Nothing.

Description

Method; loads an XML document from the specified URL, and replaces the contents of the specified XML object with the downloaded XML data. The URL is relative, and is called via HTTP. The load process is asynchronous; it does not finish immediately after the load() method is executed.

In SWF files running in a version of the player earlier than Flash Player 7, url must be in the same superdomain as the SWF file that is issuing this call. For example, a SWF file at www.someDomain.com can load variables from a SWF file at store.someDomain.com, because both files are in the same superdomain of someDomain.com.

In SWF files of any version running in Flash Player 7 or later, url must be in exactly the same domain (see Flash Player security features). For example, a SWF file at www.someDomain.com can load variables only from SWF files that are also at www.someDomain.com. If you want to load variables from a different domain, you can place a cross-domain policy file on the server hosting the SWF file that is being accessed. For more information, see About allowing cross-domain data loading.

When load() is executed, the XML object property loaded is set to false. When the XML data finishes downloading, the loaded property is set to true, and the onLoad() method is invoked. The XML data is not parsed until it is completely downloaded. If the XML object previously contained any XML trees, they are discarded.

You can specify your own event handler in place of the onLoad() method.

Example

The following is a simple example using XML.load():

doc = new XML();doc.load ("theFile.xml");

See also

XML.loaded, XML.onLoad()