Server-Side Communication ActionScript > Application.clearSharedObjects

Application.clearSharedObjects

Availability

Flash Communication Server MX.

Usage

application.clearSharedObjects(soPath);

Parameters

soPath A string that indicates the URI of a shared object.

Returns

A Boolean value of true if the shared object at the specified path was deleted; otherwise, false. If using wildcard characters to delete multiple stream files, the method will return true only if all the shared objects matching the wildcard pattern were successfully deleted; otherwise, it will return false.

Description

Method; removes persistent shared objects (FSO files) specified by the soPath parameter and clears all properties from active shared objects (both persistent and nonpersistent). You can use the SharedObject object to create shared objects in a Flash Communication Server application instance. The Flash Communication Server stores persistent shared objects for each application. You can use application.clearSharedObjects to handle one shared object at a time, so you must specify the name of the shared object. You can also use application.clearStreams to remove all the recorded streams based on a stream path.

The soPath parameter specifies the name of a shared object, which can include a slash (/) as a delimiter between directories in the path. The last element in the path can contain wildcard patterns (for example, a question mark [?] and an asterisk [*]) or a shared object name. The application.clearSharedObjects method traverses the shared object hierarchy along the specified path and clears all the shared objects. Specifying a slash clears all the shared objects associated with an application instance.

The following are possible values for the soPath parameter:

	/ clears all local and persistent shared objects associated with the instance.
	/foo/bar clears the shared object /foo/bar; if bar is a directory name, no shared objects are deleted.
	/foo/bar/* clears all shared objects stored under the instance directory /foo/bar. The bar directory is also deleted if no persistent shared objects are in use within this name space.
	/foo/bar/XX?? clears all shared objects that begin with XX, followed by any two characters. If a directory name matches this specification, all the shared objects within this directory are cleared.

If you call the clearSharedObjects method and the specified path matches a shared object that is currently active, all its properties are deleted, and a "clear" event is sent to all subscribers of the shared object. If it is a persistent shared object, the persistent store is also cleared.

Example

The following example clears all the shared objects for an instance:

function onApplicationStop(){
	application.clearSharedObjects("/");
}