User Guide

SharedObject class 125

localPath An optional string parameter that specifies the full or partial path to the SWF

file that created the shared object, and that determines where the shared object will be stored

locally. The default value is the full path. For more information on using this parameter, see

SharedObject.getRemote().

secure (Flash Player 8 only) An optional Boolean value that determines whether access to

this shared object is restricted to SWF files that are delivered over an HTTPS connection.

Assuming that your SWF file is delivered over HTTPS:

■ If this parameter is set to true, Flash Player creates a new secure shared object or gets a

reference to an existing secure shared object. This secure shared object can be read from or

written to only by SWF files delivered over HTTPS that call

SharedObject.getLocal()

with the secure parameter set to

true.

■ If this parameter is set to false, Flash Player creates a new shared object or gets a

reference to an existing shared object. This shared object can be read from or written to by

SWF files delivered over non-HTTPS connections.

If your SWF file is delivered over a non-HTTPS connection and you try to set this parameter

true, the creation of a new shared object (or the access of a previously created secure shared

object) fails and

null is returned. Regardless of the value of this parameter, the created shared

objects count toward the total amount of disk space allowed for a domain. The default value is

false.

The following diagram shows the use of the secure parameter:

Returns

A reference to a shared object that is persistent locally and is available only to the current

client. If Flash can’t create or find the shared object (for example, if

localPath was specified

but no such directory exists), this method returns

null.

This method fails and returns

null if persistent shared object creation and storage by third-

party Flash content is prohibited (does not apply to local content). Users can prohibit third-

party persistent shared objects on the Global Storage Settings panel of the Settings Manager.