Flash CS3 Documentation

ActionScript 2.0 Language Reference > ActionScript classes > LoadVars > load (LoadVars.load method)

load (LoadVars.load method)

Downloads variables from the specified URL, parses the variable data, and places the resulting variables in my_lv. Any properties in my_lv with the same names as downloaded variables are overwritten. Any properties in my_lv with different names than downloaded variables are not deleted. This is an asynchronous action.

The downloaded data must be in the MIME content type application/x-www-form-urlencoded.

This is the same format that is used by loadVariables().

Also, in files published for Flash Player 7, case-sensitivity is supported for external variables that are loaded with LoadVars.load().

This method is similar to XML.load().

Note: If a file being loaded contains non-ASCII characters (as found in many non-English languages), it is recommended that you save the file with UTF-8 or UTF-16 encoding as opposed to a non-Unicode format like ASCII.

When using this method, consider the Flash Player security model:

For Flash Player 8:

• Data loading is not allowed if the calling SWF file is in the local-with-file-system sandbox and the target resource is from a network sandbox.
• Data loading is also not allowed if the calling SWF file is from a network sandbox and the target resource is local.

For more information, see the following:

• "Understanding Security" in Learning ActionScript 2.0 in Flash
• The Flash Player 9 Security white paper at http://www.adobe.com/go/fp9_0_security
• The Flash Player 8 Security-Related API white paper at http://www.adobe.com/go/fp8_security_apis

For Flash Player 7 and later websites can permit cross-domain access to a resource through a cross-domain policy file. In SWF files of any version running in Flash Player 7 and later, url must be in exactly the same domain. For example, a SWF file at www.someDomain.com cannot load data from sources at store.someDomain.com because both files are not in the same domain.

In SWF files that are 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. A superdomain is derived by removing the leftmost component of a file's URL. For example, a SWF file at www.someDomain.com can load data from sources at store.someDomain.com because both files are in the same superdomain of someDomain.com.

Availability: ActionScript 1.0; Flash Player 6 - Behavior changed in Flash Player 7.

Parameters

url:String - A string; the URL from which to download the variables. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file.

Returns

Boolean - false if no parameter (null) is passed; true otherwise. Use the onLoad() event handler to check the success of loaded data.

Example

The following code defines an onLoad handler function that signals when data is returned to the Flash application from a server-side PHP script, and then loads the data in passvars.php.

var my_lv:LoadVars = new LoadVars();
my_lv.onLoad = function(success:Boolean) {
    if (success) {
    trace(this.toString());
    } else {
    trace("Error loading/parsing LoadVars.");
    }
};
my_lv.load("http://www.helpexamples.com/flash/params.txt");

For another example, see the Flash Samples page at www.adobe.com/go/learn_fl_samples. Download and decompress the Samples zip file and go to the ActionScript2.0\DataIntegration\Guestbook folder to access the guestbook.fla file.

See also

load (XML.load method), loaded (LoadVars.loaded property), onLoad (LoadVars.onLoad handler), useCodepage (System.useCodepage property)

Flash CS3