User Guide

402 Chapter 6: ActionScript Core Classes
SharedObject.flush()
Availability
Flash Player 6.
Usage
myLocalSharedObject.flush([minimumDiskSpace:Number]) : Boolean
Parameters
minimumDiskSpace
An optional integer specifying the number of bytes that must be allotted
for this object. The default value is 0.
Returns
A Boolean value: true or false, or a string value of "pending", as described in the following list:
• If the user has permitted local information storage for objects from this domain, and the
amount of space allotted is sufficient to store the object, this method returns
true. (If you have
passed a value for
minimumDiskSpace, the amount of space allotted must be at least equal to
that value for
true to be returned).
• If the user has permitted local information storage for objects from this domain, but the
amount of space allotted is not sufficient to store the object, this method returns
"pending".
• If the user has permanently denied local information storage for objects from this domain, or if
Flash cannot save the object for any reason, this method returns
false.
Description
Method; immediately writes a locally persistent shared object to a local file. If you don’t use this
method, Flash writes the shared object to a file when the shared object session ends—that is,
when the SWF file is closed, when the shared object is garbage-collected because it no longer has
any references to it or when you call
SharedObject.clear().
If this method returns
"pending", the Flash Player shows a dialog box asking the user to increase
the amount of disk space available to objects from this domain. To allow space for the shared
object to “grow” when it is saved in the future, which avoids return values of
"pending", pass a
value for
minimumDiskSpace. When Flash tries to write the file, it looks for the number of bytes
passed to
minimumDiskSpace, instead of looking for enough space to save the shared object at its
current size.
For example, if you expect a shared object to grow to a maximum size of 500 bytes, even though
it might start out much smaller, pass 500 for
minimumDiskSpace. If Flash asks the user to allot
disk space for the shared object, it will ask for 500 bytes. After the user allots the requested
amount of space, Flash won’t have to ask for more space on future attempts to flush the object (as
long as its size doesn’t exceed 500 bytes).
After the user responds to the dialog box, this method is called again and returns either
true or
false; SharedObject.onStatus is also invoked with a code property of
SharedObject.Flush.Success or SharedObject.Flush.Failed.
For more information, see “Local disk space considerations” on page 398.