loadVariables (MovieClip.loadVariables method)

public loadVariables(url:String, [method:String]) : Void

Reads data from an external file and sets the values for variables in the movie clip. The external file can be a text file that ColdFusion generates, a CGI script, an Active Server Page (ASP), a PHP script, or any other properly formatted text file. The file can contain any number of variables.

The loadVariables method can also be used to update variables in the active movie clip with new values.

The loadVariables method requires that the text of the URL be in the standard MIME format: application/x-www-form-urlencoded (CGI script format).

In SWF files running in a version 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 left-most component of a file's URL. For example, a SWF file at www.someDomain.com can load data from a source 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 as the SWF file that is issuing this call. For example, a SWF file at www.someDomain.com can load data only from sources that are also at www.someDomain.com. To load data from a different domain, you can place a cross-domain policy file on the server hosting the data source that is being accessed.

To load variables into a specific level, use loadVariablesNum() instead of loadVariables().

You can extend the methods and event handlers of the MovieClip class by creating a subclass.

Availability

Flash Lite 2.0

Parameters

url:String - The absolute or relative URL for the external file that contains the variables to be loaded. 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.

method:String [optional] - Specifies an HTTP method for sending variables. The parameter must be the string GET or POST. If no variables are sent, omit this parameter. The GET method appends the variables to the end of the URL and is used for small numbers of variables. The POST method sends the variables in a separate HTTP header and is used for long strings of variables.

Example

The following example loads information from a text file called params.txtinto the target_mc movie clip that is created by using createEmptyMovieClip(). The setInterval() function is used to check the loading progress. The script checks for a variable in the params.txt file named done.

this.createEmptyMovieClip("target_mc", this.getNextHighestDepth()); 
target_mc.loadVariables("params.txt"); 
function checkParamsLoaded() { 
    if (target_mc.done == undefined) { 
    trace("not yet."); 
    } else { 
    trace("finished loading. killing interval."); 
    trace("-------------"); 
    for (i in target_mc) { 
        trace(i+": "+target_mc[i]); 
    } 
    trace("-------------"); 
    clearInterval(param_interval); 
    } 
} 
var param_interval = setInterval(checkParamsLoaded, 100);

The params.txt file includes the following text:

var1="hello"&var2="goodbye"&done="done"