SharedObject.getLocal

Client-Side Communication ActionScript > SharedObject.getLocal

Availability

Flash Player 6.

Flash Communication Server MX (not required).

Usage

SharedObject.getLocal(objectName [, localPath])

Note: The correct syntax is SharedObject.getLocal. To assign the object to a variable, use syntax like myLocalSO = SharedObject.getLocal.

Parameters

objectName The name of the object. The name can include forward slashes (/); for example, work/addresses is a legal name. Spaces are not allowed in a shared object name, nor are the following characters:

~ % & \ ; :  " ' , < > ? #

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.

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.

Description

Method; returns a reference to a locally persistent shared object that is available only to the current client. To create a shared object that is available to multiple clients by means of the Flash Communication Server, use SharedObject.getRemote.

Note: If the user has chosen to never allow local storage for this domain, the object will not be saved locally, even if a value for localPath is specified. For more information, see the section on local disk space in the SharedObject (object) entry.

Because local shared objects are available only to a single client, the SharedObject.onSync method is not called when the object is changed, and there is no need to implement conflict-resolution techniques.

To avoid name collisions, Flash looks at the location of the movie that is creating the shared object. For example, if a movie at www.myCompany.com/apps/stockwatcher.swf creates a shared object named portfolio, that shared object will not conflict with another object named portfolio that was created by a movie at www.yourCompany.com/photoshoot.swf, because the movies originate from two different directories.

Example

The following example saves the last frame a user entered to a local shared object kookie.

// Get the kookie
so = sharedobject.getlocal("kookie");

// Get the user of the kookie and go to the frame number saved for this user.
if (so.data.user != undefined) {
	this.user = so.data.user;
	this.gotoAndStop(so.data.frame);
}

The following code block is placed on each movie frame.

// On each frame, call the rememberme function to save the frame number.
function rememberme() {
	so.data.frame=this._currentFrame;
	so.data.user="John";
}

	Flash Player 6.
	Flash Communication Server MX (not required).