FLfile object

Availability

Flash MX 2004 7.2.

Description

The FLfile object lets you write Flash extensions that can access, modify, and remove files and folders on the local file system. The FLfile API is provided in the form of an extension to the JavaScript API. This extension is called a shared library and is located in the following folder:

  • Windows Vista:

    boot drive\Users\username\Local Settings\Application Data\Adobe\Flash CS3\language\Configuration\External Libraries\FLfile.dll

  • Windows XP:

    boot drive\Documents and Settings\username\Local Settings\Application Data\Adobe\Flash CS3\language\Configuration\External Libraries\FLfile.dll

  • Mac OS X:

    Macintosh HD/Users/username/Library/Application Support/Adobe/Flash CS3/language/Configuration/External Libraries/FLfile.dll

Note: Don't confuse the shared libraries that contain symbols in your Flash documents with the JavaScript API shared libraries. They are two different things.

The FLfile methods work with files or folders (directories) on disk. Therefore, each method takes one or more parameters to specify the location of a file or folder. The location of the file or folder is expressed as a string in a form very similar to a website URL. It is called a file URI (Uniform Resource Identifier) and is formatted as shown here (including the quote marks):

"file:///drive|/folder 1/folder 2/.../filename"

For example, if you want to create a folder on the C drive called config and place it in the Program Files/MyApp folder, use the following command:

FLfile.createFolder("file:///C|/Program Files/MyApp/config");

If you then want to place a file called config.ini in that folder, use the following command:

FLfile.write("file:///C|/Program Files/MyApp/config/config.ini", "");

To create a folder on the Macintosh, you could use the following command:

FLfile.createFolder("file:///Macintosh/MyApp/config");

Method summary

The following methods can be used with the FLfile object:

Method

Description

FLfile.copy()

Copies a file.

FLfile.createFolder()

Creates one or more folders.

FLfile.exists()

Determines the existence of a file or folder.

FLfile.getAttributes()

Finds out whether a file is writable, read-only, hidden, visible, or a system folder.

FLfile.getCreationDate()

Specifies how many seconds have passed between January 1, 1970 and the time the file or folder was created.

FLfile.getCreationDateObj()

Gets the date a file or folder was created.

FLfile.getModificationDate()

Specifies how many seconds have passed between January 1, 1970 and the time the file or folder was last modified.

FLfile.getModificationDateObj()

Gets the date a file or folder was last modified.

FLfile.getSize()

Gets the size of a file.

FLfile.listFolder()

Lists the contents of a folder.

FLfile.platformPathToURI()

Converts a filename in a platform-specific format to a file:/// URI.

FLfile.read()

Reads the contents of a file.

FLfile.remove()

Deletes a file or folder.

FLfile.setAttributes()

Makes a file or folder read-only, writable, hidden, or visible.

FLfile.uriToPlatformPath()

Converts a filename expressed as a file:/// URI to a platform-specific format.

FLfile.write()

Creates, writes to, or appends to a file.