Macromedia flash media server 2-client-side actionscript language reference for flash media server 2 ユーザーズマニュアル

122

Client-Side ActionScript Language Reference

SharedObject.flush()

Availability

■

Flash Player 6.

■

Flash Media Server (not required).

Usage

myLocalOrRemote_so.flush([minimumDiskSpace])

Parameters

  An optional integer specifying the number of bytes that must be 

allotted for this object. The default value is 0.

Returns

A Boolean value of 

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 

, 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 is unable to 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 

.

If this method returns 

"pending"

, the Flash Player displays 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, thus avoiding return values of 

"pending"

, pass a value for 

. When Flash tries to write the file, it looks 

for the number of bytes passed to 

, instead of looking for just enough 

space to save the shared object at its current size.