LocalConnection.send()

Availability

Flash Player 6.

Usage

sending_lc.send (connectionName, method [, p1,...,pN])

Parameters

connectionName A string that corresponds to the connection name specified in the LocalConnection.connect() command that wants to communicate with sending_lc.

method A string specifying the name of the method to be invoked in the receiving LocalConnection object. The following method names cause the command to fail: send, connect, close, domain, onStatus, and allowDomain.

p1,...pN Optional parameters to be passed to the specified method.

Returns

A Boolean value of true if Flash can carry out the request, false otherwise.

Note: A return value of true does not necessarily mean that Flash successfully connected to a receiving LocalConnection object, only that the command is syntactically correct. To determine whether the connection succeeded, see LocalConnection.onStatus.

Description

Method; invokes the method named method on a connection opened with the LocalConnection.connect(connectionName) command (called the "receiving LocalConnection object"). The object used with this command is called the "sending LocalConnection object". The SWF files that contain the sending and receiving objects must be running on the same client machine.

There is a limit to the amount of data you can pass as parameters to this command. If the command returns false but your syntax is correct, try breaking up the LocalConnection.send() requests into multiple commands.

As discussed in the entry LocalConnection.connect(), Flash adds the current superdomain to connectionName by default. If you are implementing communication between different domains, you need to define connectionName in both the sending and receiving LocalConnection objects in such a way that Flash does not add the current superdomain to connectionName. There are two ways you can do so:

Use an underscore (_) at the beginning of connectionName in both the sending and receiving LocalConnection objects. In the SWF file containing the receiving object, use LocalConnection.allowDomain to specify that connections from any domain will be accepted. This implementation lets you store your sending and receiving SWF files in any domain.
Include the superdomain in connectionName in the sending LocalConnection object—for example, myDomain.com:myConnectionName. In the receiving object, use LocalConnection.allowDomain to specify that connections from the specified superdomain will be accepted (in this case, myDomain.com), or that connections from any domain will be accepted.

Note: You cannot specify a superdomain in connectionName in the receiving LocalConnection object, only in the sending LocalConnection object.

Example

For an example of communicating between LocalConnection objects located in the same domain, see LocalConnection.connect(). For an example of communicating between LocalConnection objects located in any domain, see LocalConnection.allowDomain. For an example of communicating between LocalConnection objects located in specified domains, see LocalConnection.allowDomain and LocalConnection.domain().