Sharedobject.flush() - MACROMEDIA FLASH MX 2004-ACTIONSCRIPT LANGUAGE Reference

SharedObject.flush()

Availability
Flash Player 6.
Usage
myLocalSharedObject.flush([minimumDiskSpace:Number]) : Boolean
Parameters
minimumDiskSpace
for this object. The default value is 0.
Returns
A Boolean value:
•
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
passed a value for
that value for
•
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
•
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
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
If this method returns
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
value for
minimumDiskSpace
passed to
minimumDiskSpace
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
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
;
false SharedObject.onStatus
SharedObject.Flush.Success
For more information, see
740 Chapter 2: ActionScript Language Reference
An optional integer specifying the number of bytes that must be allotted
or , or a string value of
true false
minimumDiskSpace
to be returned).
true
SharedObject.clear()
, the Flash Player shows a dialog box asking the user to increase
"pending"
. When Flash tries to write the file, it looks for the number of bytes
, instead of looking for enough space to save the shared object at its
is also invoked with a
or
SharedObject.Flush.Failed
"Local disk space considerations" on page
"pending"
, the amount of space allotted must be at least equal to
.
minimumDiskSpace
property of
code
, as described in the following list:
. (If you have
true
"pending"
.
false
"pending"
. If Flash asks the user to allot
.
735.
.
, pass a
or
true