File  - AS3

インストールされたアプリケーションファイルが格納されているフォルダーです。

このオブジェクトの url プロパティは、app URL スキーム（file URL スキームではない）を使用します。したがって、url ストリングの指定は「app:」（「file:」）ではない）で始めます。また、File.applicationDirectory ディレクトリを基準とする相対位置に（resolvePath() メソッドを使用して）File オブジェクトを作成すると、その File オブジェクトの url プロパティでも app URL スキームが使用されます。

注意：app: URL スキームを使用するパスを持つファイルまたはディレクトリに書き込むことはできません。また、app: URL スキームを使用するパスを持つファイルやフォルダーの削除または作成を行うこともできません。アプリケーションディレクトリの内容を変更することはセキュリティ上の理由から推奨されません。したがって、一部のプラットフォームではオペレーティングシステムによってブロックされます。アプリケーション固有のデータを格納する必要がある場合は、アプリケーションの記憶領域ディレクトリ（File.applicationStorageDirectory）を使用することを検討してください。アプリケーションの記憶領域ディレクトリ内のコンテンツがアプリケーション特権機能（AIR API）にアクセスできるようにする必要がある場合は、サンドボックスブリッジを使用してその機能を公開します。

applicationDirectory プロパティを使用すると、異なるプラットフォームでも動作する方法でアプリケーションディレクトリを参照できます。アプリケーションディレクトリを参照するように File オブジェクトを設定する際、nativePath または url プロパティを直接に使用すると、そのパスが有効であるプラットフォーム上でしか動作しないコードになります。

Android では、アプリケーションディレクトリを示す File オブジェクトの nativePath プロパティは空の文字列です。アプリケーションファイルにアクセスするには、url プロパティを使用します。

関連する API エレメント

アプリケーションのプライベート記憶領域ディレクトリです。

それぞれの AIR アプリケーションは、永続的な固有のアプリケーション記憶領域ディレクトリを持っています。このディレクトリは、File.applicationStorageDirectory に初めてアクセスしたときに作成されます。このディレクトリは、アプリケーションおよびユーザーごとに一意に割り当てられます。このディレクトリは、ユーザー固有またはアプリケーション固有のデータを格納するために利用されます。

AIR アプリケーションのアンインストール時に、アプリケーション記憶領域ディレクトリとその中のファイルが削除されるかどうかは、プラットフォームによって異なります。

このオブジェクトの url プロパティは、app-storage URL スキーム（file URL スキームではない）を使用します。したがって、url ストリングの指定は「app-storage:」（「file:」）ではない）で始めます。また、File.applicationStoreDirectory ディレクトリを基準とする相対位置に（resolvePath() メソッドを使用して）File オブジェクトを作成すると、その File オブジェクトの url でも app-storage URL スキームが使用されます（例を参照）。

applicationStorageDirectory プロパティを使用すると、異なるプラットフォームでも動作する方法でアプリケーション記憶領域ディレクトリを参照できます。アプリケーション記憶領域ディレクトリを参照するように File オブジェクトを設定する際、nativePath または url プロパティを直接に使用すると、そのパスが有効であるプラットフォーム上でしか動作しないコードになります。

注意（Mac OS のみ）：Mac App Store 要件に準拠するために、このディレクトリの物理的な場所は AIR 3.2 と AIR 3.3 の間に変更されました。

• 3.2 以前の名前空間：~/Library/Preferences/appid/Local Store/
• 3.3 以降の名前空間：path/Library/Application Support/appid/Local Store/。path は ~/Library/Containers/bundle-id/Data（サンドボックス化した環境の場合）または ~ （サンドボックス化した環境外で実行する場合）

import flash.filesystem.File;

var tempFiles:File = File.applicationStorageDirectory;
tempFiles = tempFiles.resolvePath("images/");
trace(tempFiles.url); // app-storage:/images

アプリケーションのキャッシュディレクトリです。

cacheDirectory プロパティでは、キャッシュディレクトリを参照できます。アプリケーションでキャッシュディレクトリを使用して、サーバーからダウンロードされたファイルを格納することをお勧めします。キャッシュディレクトリを使用しない場合は、それらのファイルは再生成されます。キャッシュディレクトリに格納すべきファイルの例として、データベースキャッシュファイルや、雑誌、新聞および地図アプリケーションで使用するようなダウンロード可能コンテンツが挙げられます。

キャッシュディレクトリを参照するように File オブジェクトを設定する際、nativePath または url プロパティを直接に使用すると、そのパスが有効であるプラットフォーム上でしか動作しないコードになります。

オペレーティングシステムでキャッシュディレクトリがサポートされていない場合、cacheDirectory は null です。

ユーザーのデスクトップディレクトリです。

desktopDirectory プロパティを使用すると、異なるプラットフォームでも動作する方法でデスクトップディレクトリを参照できます。デスクトップディレクトリを参照するように File オブジェクトを設定する際、nativePath または url プロパティを直接に使用すると、そのパスが有効であるプラットフォーム上でしか動作しないコードになります。

オペレーティングシステムがデスクトップディレクトリをサポートしていない場合、ファイルシステムの適切なディレクトリが代わりに使用されます。

AIR for TV デバイスには、ユーザーのデスクトップディレクトリという概念がありません。このため、desktopDirectory プロパティの参照先は File.userDirectory プロパティの示すディレクトリと同じ場所です。ユーザーディレクトリは、アプリケーションに固有の場所にあります。

import flash.filesystem.File;
var desktop:File = File.desktopDirectory;

var files:Array = desktop.getDirectoryListing();

for (var i:uint = 0; i < files.length; i++) {
    trace(files[i].nativePath);
}

ユーザーのドキュメントディレクトリです。

Windows では、これは My Documents ディレクトリ（例えば C:\Documents and Settings\userName\My Documents）です。Mac OS のデフォルトの位置は /Users/userName/Documents です。Linux のデフォルトの位置は /home/userName/Documents（英語システムの場合）で、プロパティは xdg-user-dirs 設定に従います。

documentsDirectory プロパティを使用すると、異なるプラットフォームでも動作する方法でドキュメントディレクトリを参照できます。ドキュメントディレクトリを参照するように File オブジェクトを設定する際、nativePath または url プロパティを直接に使用すると、そのパスが有効であるプラットフォーム上でしか動作しないコードになります。

オペレーティングシステムがドキュメントディレクトリをサポートしていない場合、ファイルシステムの適切なディレクトリが代わりに使用されます。

AIR for TV デバイスには、ユーザーのドキュメントディレクトリという概念がありません。このため、documentsDirectory プロパティの参照先は File.userDirectory プロパティの示すディレクトリと同じ場所です。ユーザーディレクトリは、アプリケーションに固有の場所にあります。

import flash.filesystem.File;

var directory:File = File.documentsDirectory;
directory = directory.resolvePath("AIR Test");

File.createDirectory(directory);
trace(directory.exists); // true

参照先のファイルまたはディレクトリが、インターネット経由でダウンロード済みであるかどうかを示します。

このプロパティは、ファイルにダウンロード済みのフラグを付けられるオペレーティングシステム（以下参照）でのみ意味を持ちます。

• Windows XP Service Pack 2 以降および Windows Vista
• Mac OS 10.5 以降

ファイルにダウンロード済みのフラグが付かないシステム（Linux など）では、このプロパティは意味を持ちません（false に設定されます）。

関連する API エレメント

参照先のファイルまたはディレクトリが存在するかどうかを示します。値は、File オブジェクトが既存のファイルまたはディレクトリを指している場合は true、それ以外の場合は false です。

import flash.filesystem.*;

var temp:File = File.createTempFile();
trace(temp.exists); // true
temp.deleteFile();
trace(temp.exists); // false

ファイルに対して定義されたアイコンを格納している Icon オブジェクトです。Icon オブジェクトは、様々なアイコン状態に対応する BitmapData オブジェクトの配列です。Linux では、Icon オブジェクトにアイコンはありません。Android では、icon プロパティは null です。

import flash.filesystem.File;
import flash.display.*;

var directory:File = File.documentsDirectory;
var bitmaps:Array = directory.icon.bitmaps;
var bmpData:BitmapData = new BitmapData(1, 1);
for (var i:uint = 0; i < bitmaps.length; i++) {
    if (bitmaps[i].height > bmpData.height) {
        bmpData = directory.icon.bitmaps[i];
    }
}
var iconBmp:Bitmap = new Bitmap(bmpData);

参照先がディレクトリであるかどうかを示します。値は、File オブジェクトの参照先がディレクトリの場合は true、それ以外の場合は false です。

import flash.filesystem.*;

var userDirFiles:Array = File.userDirectory.getDirectoryListing();
for (var i:uint = 0; i < userDirFiles.length; i++) {
    if (userDirFiles[i].isDirectory) {
        trace(userDirFiles[i].nativePath);
    }
}    

参照先のファイルまたはディレクトリが "非表示" かどうかを示します。値は、参照先のファイルまたはディレクトリが非表示の場合は true、それ以外の場合は false です。

import flash.filesystem.*;

var userDirFiles:Array = File.userDirectory.getDirectoryListing();
for (var i:uint = 0; i < userDirFiles.length; i++) {
    if (userDirFiles[i].isHidden) {
        trace(userDirFiles[i].nativePath);
    }
}    

参照先のディレクトリがパッケージであるかどうかを示します。

値は、参照先のディレクトリがパッケージである場合は true、それ以外の場合は false です。File クラスでは、パッケージを直接作成することはできません。

• Macintosh では、ディレクトリをパッケージとして指定して、Finder にディレクトリではなく単一のファイルとして表示することができます。このプロパティは、参照先のディレクトリがパッケージである場合は true、そのファイルがディレクトリでない場合、存在しない場合、またはパッケージでない場合は false に設定されます。
• 他のオペレーティングシステムでは、このプロパティは常に false に設定されます。

参照がシンボリックリンクであるかどうかを示します。

値は、File オブジェクトがシンボリックリンクの場合は true、それ以外の場合は false です。File クラスでは、シンボリックリンクを直接作成することはできません。

シンボリックリンクを使用すると、ファイルが、ディスク上の別のファイルまたはディレクトリを参照できるようになります。シンボリックリンクは、エイリアス（Macintosh）およびショートカット（Windows）に似ていますが、同じではありません。エイリアスまたはショートカットは常に（ディレクトリではなく）ファイルとして報告され、エイリアスまたはショートカットの読み取りや書き込みを行っても、そのエイリアスまたはショートカットの参照先である元のファイルまたはディレクトリが影響を受けることはありません。これに対し、シンボリックリンクは、通常、参照先のファイルまたはディレクトリと同じように動作します。シンボリックリンクは、ファイルまたはディレクトリとして報告され、シンボリックリンクの読み取りや書き込みを行うと、シンボリックリンク自体ではなく、参照先のファイルまたはディレクトリが影響を受けます。ただし、シンボリックリンクを削除すると、リンクの対象ではなくリンクが削除されます。

シンボリックリンクは Mac^® OS^®、Linux、および Windows^® Vista^® でサポートされています。さらに、Windows では、NTFS ファイルシステムで使用される接続点を参照している File オブジェクトの isSymbolicLink プロパティは true に設定されます。

ホストオペレーティングシステムで使用される行終了文字です。

Macintosh OS および Linux では、これは改行文字（16 進の文字コード 0x0A）です。Windows では、復帰文字（16 進の文字コード 0x0A）の後に改行文字（16 進の文字コード 0x0A) が続いたものです。

import flash.filesystem.*;

var str:String = "Hello\n" + 
        "World\n";
str = str.replace(/\n/g, File.lineEnding);
var file:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.WRITE);
fileStream.writeUTF(str);
fileStream.close();

ホストオペレーティングシステムの表現形式に従った完全パスです。Macintosh OS および Linux では、パス区切り文字としてスラッシュ（/）文字を使用します。ただし、Windows では、nativePath プロパティでパス区切り文字としてスラッシュ（/）を使用するか円記号（¥）を使用するかを設定できます。AIR では、スラッシュが適切な円記号（¥）文字に自動で変換されます。

直接に nativePath プロパティを設定するコードを記述することは可能ですが、特定プラットフォーム上でしか動作しないコードになる可能性があることに注意してください。例えば、"C:\\Documents and Settings\\bob\\Desktop" のようなネイティブパスは Windows 上でのみ有効です。それよりも、共通的に使用されるディレクトリを次の静的プロパティで参照するほうがはるかに望ましく、どのプラットフォームでも有効なコードを作成できます。

• File.applicationDirectory
• File.applicationStorageDirectory
• File.desktopDirectory
• File.documentsDirectory
• File.userDirectory

resolvePath() メソッドを使用すると、上記の各種ディレクトリからの相対パスを取得できます。

一部の Flex API（SWFLoader クラスの source プロパティなど）では、URL（File オブジェクトの url プロパティ）を使用します。ネイティブパス（nativePath プロパティ）は使用しません。

import flash.filesystem.File;

var docs:File = File.documentsDirectory;
trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents

この File オブジェクトによって参照されているファイルまたはディレクトリを格納しているディレクトリです。

parent プロパティは、参照先のファイルまたはディレクトリが存在しない場合でも、それを格納しているディレクトリを指す File オブジェクトを返します（そのディレクトリが存在しなくても返します）。

このプロパティは、resolvePath("..") の戻り値と同じですが、ルートディレクトリの親が null である点が異なります。

import flash.filesystem.File;

var tempFile:File = File.createTempDirectory();
trace(tempFile.parent.nativePath);
tempFile.deleteFile();

ファイルシステムにアクセスする権限をアプリケーションが付与されたかどうかを判定します。

関連する API エレメント

ランタイムでこの File オブジェクトがクラウドにバックアップされないかどうかを示します。

このプロパティが true に設定されている場合、このバックアップサービスを提供するプラットフォームで、File オブジェクトがクラウドに自動的にバックアップされません。このプロパティのデフォルト値は false です。

ホストオペレーティングシステムのパスコンポーネントの区切り文字です。

Macintosh OS および Linux では、スラッシュ（/）文字です。 Windows では、円記号（\）です。

注意：ストリングリテラル内で円記号文字を使用する場合は、円記号を 2 回入力してください（例："directory\\file.ext"）。ストリングリテラル内では、2 つの円記号によってストリング内の単一の円記号を表します。

import flash.filesystem.File;

var directory:File = File.documentsDirectory.resolvePath("Apollo Test");
var file:File = File.documentsDirectory.resolvePath("Apollo Test/employees/bob/test.txt");

var relativePath:String = directory.getRelativePath(file); // employees/bob/test.txt
relativePath = relativePath.replace(/\//g, File.separator);
trace(relativePath); 

この File の場所で使用可能な領域（バイト）。

File オブジェクトがディレクトリを参照する場合、spaceAvailable はファイルで使用できるディレクトリの領域を示します。File オブジェクトがファイルを参照する場合、spaceAvailable はファイルを拡張できる領域を示します。ファイルの場所が存在しない場合、spaceAvailable は 0 に設定されます。File オブジェクトがシンボリックリンクを参照する場合、spaceAvailable はシンボリックリンクが参照する位置で使用可能な領域を示します。

一般的に、ディレクトリまたはファイルで使用可能な領域は、ディレクトリまたはファイルを含むボリュームで使用可能な領域と同じです。ただし、使用可能な領域では、割り当ておよびディレクトリごとの制限が考慮される場合があります。

一般に、ボリュームにファイルまたはディレクトリを追加すると、ファイルの実際のサイズまたはディレクトリの内容のサイズよりも大きな領域が必要になります。例えば、オペレーティングシステムでは、インデックス情報を保存するための追加領域が必要になる場合があります。また、必要なディスクセクタにより追加領域が使用される場合があります。さらに、使用可能な領域は動的に変化します。したがって、報告されたすべての領域がファイル記憶域のために割り当てられることを期待するのは不可能です。

ホストオペレーティングシステムで使用されるデフォルトのエンコーディングです。

有効な値は、"windows-1252"、"shift-jis"、"cn-gb"、"iso-8859-1" などです。完全な一覧については、「サポートされている文字セット」を参照してください。

この値は、FileStream クラスの readMultiByte() メソッドおよび writeMultiByte() メソッドで使用できます。

関連する API エレメント

import flash.filesystem.File;

var file:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.READ);
var str:String = fileStream.readMultiByte(file.size, File.systemCharset);
trace(str);    

このファイルパスの URL です。

この URL スキームは、アプリケーションの記憶領域ディレクトリ内のパスへの参照である場合は「app-storage」、アプリケーションディレクトリ内のパスへの参照である場合は「app」、それ以外の場合は「file」です。

（"%20"ではなく）空白文字を使用して、url プロパティに値を代入できます。この場合、AIR によってストリングが自動的にエンコードされます（例えば、スペースが "%20" に変換されます）。

関連する API エレメント

import flash.filesystem.File;

var docs:File = File.documentsDirectory;
trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents

ユーザーのディレクトリです。

Windows では、これは "My Documents" ディレクトリの親（例えば C:¥Documents and Settings¥userName）です。Macintosh では、/Users/userName です。 Linux では、/home/userName です。

userDirectory プロパティを使用すると、異なるプラットフォームでも動作する方法でユーザーディレクトリを参照できます。File オブジェクトの nativePath または url プロパティを直接に設定するコードは、そのパスが有効であるプラットフォーム上でしか動作しません。

オペレーティングシステムがユーザーディレクトリをサポートしていない場合、ファイルシステムの適切なディレクトリが代わりに使用されます。

AIR for TV デバイスでは、userDirectory プロパティはアプリケーションに固有のユーザーディレクトリを示します。

import flash.filesystem.File;

var files:Array = File.userDirectory.listDirectory();
for (var i:uint = 0; i < files.length; i++) {
    trace(files[i].nativePath);
}

File クラスのコンストラクター関数です。

path 引数を渡した場合、File オブジェクトは指定されたパスを参照し、そのパスを反映するように nativePath プロパティと url プロパティが設定されます。

引数 path を渡してファイルパスを指定することは可能ですが、特定プラットフォーム上でしか動作しないコードになる可能性があることに注意してください。例えば、"C:¥¥Documents and Settings¥¥bob¥¥Desktop" のようなネイティブパスや "file:///C:/Documents%20and%20Settings/bob/Desktop" のような URL は、Windows 上でのみ有効です。それよりも、共通的に使用されるディレクトリを次の静的プロパティで参照するほうがはるかに望ましく、どのプラットフォームでも有効なコードを作成できます。

• File.applicationDirectory
• File.applicationStorageDirectory
• File.desktopDirectory
• File.documentsDirectory
• File.userDirectory

その上で、resolvePath() メソッドを使用することにより、上記の各種ディレクトリからの相対パスを取得できます。例えば、次のコードでは、アプリケーション記憶領域ディレクトリ内の settings.xml ファイルを指すように File オブジェクトをセットアップしています。

var file:File = File.applicationStorageDirectory.resolvePath("settings.xml");

重要：path パラメーターで URL ストリングを渡すと、URL がデコードされ、ファイルパスが解決されます。例えば、ステートメント new File("file:///c:/test/demo%20file%201%2e0.txt") では、ネイティブパス "c:\test\demo file 1.0.txt" を持つ File オブジェクトが作成されます（URL では、file:、app: または app-storage: スキーム接頭辞が使用されます）。ただし、有効な URL 接頭辞が省略されている場合は、パスストリングはネイティブパスのように扱われ、デコードは実行されません。信頼されていない可能性があるソースから派生したパスを検証するときは、このビヘイビアーを考慮する必要があります。入力ストリングを検証するだけだと、URL デコードでは、攻撃者が検証チェックを回避できる可能性があります。インスタンス化された File オブジェクトの最終パスは必ず検証してください。

     var file:File = new File( taintedString );
     validate( file.nativePath ); //where validate() is your path validation function
     

関連する API エレメント

ディレクトリ選択ダイアログボックスを表示して、ユーザーがディレクトリを選択できるようにします。ユーザーがディレクトリを選択すると、select イベントが送出されます。target プロパティ（select イベントで指定）は、選択されたディレクトリを指している File オブジェクトです。

ディレクトリ選択ダイアログボックスは、他のウィンドウによって「所有されている」（owner プロパティが null 以外に設定されている）ウィンドウの前面に常に表示されるとは限りません。ウィンドウの表示順序の問題を回避するには、このメソッドを呼び出す前に所有されているウィンドウを非表示にします。

注意：Android デバイスでは、browseForDirectory() はサポートされません。File オブジェクトは cancel イベントを即座に送出します。

パラメーター

関連する API エレメント

import flash.filesystem.File;
import flash.events.Event;

var directory:File = File.documentsDirectory;

try
{
    directory.browseForDirectory("Select Directory");
    directory.addEventListener(Event.SELECT, directorySelected);
}
catch (error:Error)
{
    trace("Failed:", error.message);
}

function directorySelected(event:Event):void 
{
    directory = event.target as File;
    var files:Array = directory.getDirectoryListing();
    for(var i:uint = 0; i < files.length; i++)
    {
        trace(files[i].name);
    }
}

ファイルを開くダイアログボックスを表示して、ユーザーが開くファイルを選択できるようにします。

ユーザーがファイルを選択すると、select イベントが送出されます。target プロパティ（select イベントで指定）は、選択されたファイルを指している File オブジェクトです。

ファイルを開くダイアログボックスは、他のウィンドウによって「所有されている」（owner プロパティが null 以外に設定されている）ウィンドウの前面に常に表示されるとは限りません。ウィンドウの表示順序の問題を回避するには、このメソッドを呼び出す前に所有されているウィンドウを非表示にします。

注意：Android デバイスでは、ファイルのダイアログタイトルは設定できません。title パラメーターは無視されます。

パラメーター

関連する API エレメント

import flash.filesystem.*;
import flash.events.Event;
import flash.net.FileFilter;

var fileToOpen:File = new File();
var txtFilter:FileFilter = new FileFilter("Text", "*.as;*.css;*.html;*.txt;*.xml");

try 
{
    fileToOpen.browseForOpen("Open", [txtFilter]);
    fileToOpen.addEventListener(Event.SELECT, fileSelected);
}
catch (error:Error)
{
    trace("Failed:", error.message);
}

function fileSelected(event:Event):void 
{
    var stream:FileStream = new FileStream();
    stream.open(event.target, FileMode.READ);
    var fileData:String = stream.readUTFBytes(stream.bytesAvailable);
    trace(fileData);
}

ファイルを開くダイアログボックスを表示して、ユーザーが開くファイルを 1 つ以上選択できるようにします。

ユーザーがファイルを選択すると、selectMultiple イベントが送出されます。target プロパティ（select イベントで指定）は、この File オブジェクトです。browseForOpen() とは異なり、browseForOpenMultiple() メソッドを使用すると、この File オブジェクトは、選択されたファイルを参照するために更新されません。その代わり、結果として得られる selectMultiple イベントには、選択されたファイルの配列が格納されます。

ファイルを開くダイアログボックスは、他のウィンドウによって「所有されている」（owner プロパティが null 以外に設定されている）ウィンドウの前面に常に表示されるとは限りません。ウィンドウの表示順序の問題を回避するには、このメソッドを呼び出す前に所有されているウィンドウを非表示にします。

注意：Android デバイスでは、ファイルのダイアログタイトルは設定できません。title パラメーターは無視されます。

パラメーター

関連する API エレメント

import flash.filesystem.*;
import flash.events.FileListEvent;

var docsDir:File = File.documentsDirectory;
try
{
    docsDir.browseForOpenMultiple("Select Files");
    docsDir.addEventListener(FileListEvent.SELECT_MULTIPLE, filesSelected);
}
catch (error:Error)
{
    trace("Failed:", error.message);
}

function filesSelected(event:FileListEvent):void 
{
    for (var i:uint = 0; i < event.files.length; i++) 
    {
        trace(event.files[i].nativePath);
    }
}

ファイルを保存ダイアログボックスを表示して、ユーザーがファイルの保存先を選択できるようにします。

ユーザーがファイルを選択すると、select イベントが送出されます。target プロパティ（select イベントで指定）は、選択された保存先を指している File オブジェクトです。

ファイルを保存ダイアログボックスは、他のウィンドウによって「所有されている」（owner プロパティが null 以外に設定されている）ウィンドウの前面に常に表示されるとは限りません。ウィンドウの表示順序の問題を回避するには、このメソッドを呼び出す前に所有されているウィンドウを非表示にします。

注意：Android デバイスでは、ファイルのダイアログタイトルは設定できません。title パラメーターは無視されます。

パラメーター

関連する API エレメント

import flash.filesystem.*;
import flash.events.Event;

var docsDir:File = File.documentsDirectory;
try
{
    docsDir.browseForSave("Save As");
    docsDir.addEventListener(Event.SELECT, saveData);
}
catch (error:Error)
{
    trace("Failed:", error.message);
}

function saveData(event:Event):void 
{
    var newFile:File = event.target as File;
    var str:String = "Hello.";
    if (!newFile.exists)
    {
        var stream:FileStream = new FileStream();
        stream.open(newFile, FileMode.WRITE);
        stream.writeUTFBytes(str);
        stream.close();
    }
}

保留中の非同期処理をキャンセルします。

File のパスを標準化します。

File オブジェクトが既存のファイルまたはディレクトリを表している場合は、標準化によって、実際のファイル名またはディレクトリ名と大文字小文字が一致するようにパスが調整されます。File オブジェクトがシンボリックリンクである場合は、標準化によって、参照先のファイルまたはディレクトリが存在するかどうかにかかわらず、リンクが指しているファイルまたはディレクトリに一致するようにパスが調整されます。小文字と大文字が区別されるファイルシステム（Linux など）では、小文字と大文字が異なるだけの名前のファイルが複数存在すると、canonicalize() メソッドは（ファイルシステムによって指定された順序で）最初に発見されたファイルと一致するようにパスを調整します。

また、Windows では、標準化によって、短いファイル名が長いファイル名に変換されます。

import flash.filesystem.*;

var path:File = File.desktopDirectory.resolvePath("air test");
trace(path.nativePath); 
path.canonicalize();
trace(path.nativePath); // ...\AIR Test

import flash.filesystem.*;

var path:File = new File();
path.nativePath = "C:\\AIR~1";
path.canonicalize();
trace(path.nativePath); // C:\AIR Test

この File オブジェクトのコピーを返します。イベント登録はコピーされません。

注意：このメソッドでは、ファイル自体がコピーされるのではありません。 単に、ActionScript File オブジェクトのインスタンスのコピーが作成されるだけです。ファイルをコピーするには、copyTo() メソッドを使用します。

この File オブジェクトで指定された場所にあるファイルまたはディレクトリを、newLocation パラメーターで指定された場所にコピーします。コピー処理によって、可能な場合には必要な親ディレクトリが作成されます。copyTo() を使用してファイルを上書きすると、ファイルの属性も上書きされます。

パラメーター

関連する API エレメント

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:FileReference = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
var destination:FileReference = File.documentsDirectory;
destination = destination.resolvePath("AIR Test/test2.txt");

if (sourceFile.copyTo(destination, true)) {
    trace("Done.");
}

import flash.filesystem.File;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolvePath("AIR Test/test2.txt");

try 
{
    sourceFile.copyTo(destination, true);
}
catch (error:Error)
{
    trace("Error:", error.message);
}

この File オブジェクトで指定された場所にあるファイルまたはディレクトリを、destination パラメーターで指定された場所にコピーする処理を開始します。

完了後、complete イベント（成功）または ioError イベント（失敗）が送出されます。コピー処理によって、可能な場合には必要な親ディレクトリが作成されます。

パラメーター

関連する API エレメント

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolvePath("AIR Test/test2.txt");

sourceFile.copyToAsync(destination, true);
sourceFile.addEventListener(Event.COMPLETE, fileCopiedHandler);

function fileCopiedHandler(event:Event):void {
    trace("Done.");
}

指定されたディレクトリおよび必要な親ディレクトリを作成します。ディレクトリがすでに存在する場合は、何も行われません。

import flash.filesystem.*;

var source:File = File.desktopDirectory.resolvePath("test.txt");
var target:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
var targetParent:File = target.parent;
targetParent.createDirectory();
source.moveTo(target, true);

新しい一時ディレクトリへの参照を返します。これは、システムの一時ディレクトリパスに作成される新しいディレクトリです。

このメソッドを使用すると、新しい一意のディレクトリを指定できます。システムに照会してディレクトリが新規かつ一意であることを確認する必要はありません。

デバイスによっては、一時ディレクトリは自動では削除されないため、アプリケーションを閉じる前に削除することを検討してください。

関連する API エレメント

import flash.File;

var temp:File = File.createTempDirectory();
trace(temp.nativePath);

新しい一時ファイルへの参照を返します。これは、システムの一時ディレクトリパスに作成される新しいファイルです。

このメソッドを使用すると、新しい一意のファイルを指定できます。システムに照会してファイルが新規かつ一意であることを確認する必要はありません。

一時ファイルは自動では削除されないため、アプリケーションを閉じる前に削除することを検討してください。

関連する API エレメント

import flash.File;

var temp:File = File.createTempFile();
trace(temp.nativePath);

ディレクトリを削除します。このファイルが実際にディレクトリに対するシンボリックリンクの場合は、ディレクトリではなくこのリンクが削除されます。

パラメーター

関連する API エレメント

import flash.filesystem.File;

var directory:File = File.documentsDirectory.resolvePath("Empty Junk Directory/");
File.createDirectory(directory);
trace(directory.exists); // true
directory.deleteDirectory();
trace(directory.exists); // false

ディレクトリを非同期で削除します。このファイルが実際にディレクトリに対するシンボリックリンクの場合は、ディレクトリではなくこのリンクが削除されます。

パラメーター

関連する API エレメント

ファイルを削除します。このファイルが実際にシンボリックリンクの場合は、ターゲットファイルではなくこのリンクが削除されます。

関連する API エレメント

import flash.filesystem.*;

var file:File = File.createTempFile();
trace(file.exists); // true
file.deleteFile();
trace(file.exists); // false

ファイルを非同期で削除します。このファイルが実際にシンボリックリンクの場合は、ターゲットファイルではなくこのリンクが削除されます。

関連する API エレメント

この File オブジェクトによって表されるディレクトリ内のファイルおよびディレクトリに対応する File オブジェクトの配列を返します。このメソッドは、サブディレクトリの内容は調べません。

関連する API エレメント

import flash.filesystem.File;

var directory:File = File.userDirectory;
var list:Array = directory.getDirectoryListing();
for (var i:uint = 0; i < list.length; i++) {
    trace(list[i].nativePath);
}

この File オブジェクトによって表されるディレクトリの内容に対応する File オブジェクトの配列を非同期で取得します。

関連する API エレメント

import flash.filesystem.File;
import flash.events.FileListEvent;

var directory:File = File.userDirectory;
directory.getDirectoryListingAsync();
directory.addEventListener(FileListEvent.DIRECTORY_LISTING, directoryListingHandler);

function directoryListingHandler(event:FileListEvent):void {
    var list:Array = event.files;
    for (var i:uint = 0; i < list.length; i++) {
        trace(list[i].nativePath);
    }
}

2 つの File パス間の相対パスを探します。

相対パスは、2 つ目の（パラメーター）参照を見つけるためにこの参照に追加（解決）されるコンポーネントのリストです。相対パスは、区切り文字 "/" を使用して返されます。

必要に応じて、相対パスに ".." 参照を含めることができますが、そのようなパスが明確なボリューム境界を越えることはありません。

パラメーター

ファイルシステムのルートディレクトリを列挙している File オブジェクトの配列を返します。

例えば、Windows ではこれは C: ドライブや D: ドライブなどのボリュームのリストです。ディスクが挿入されていない CD または DVD ドライブなどの空のドライブは、この配列に含まれません。Mac OS および Linux の場合、このメソッドは常にマシンの一意のルートディレクトリを返します（「/」ディレクトリ）。

Android ファイルシステムなど、ルートが読み取り可能なファイルシステムでは、返される File オブジェクトのプロパティは実際の値を反映するとは限りません。例えば、Android の spaceAvailable プロパティでは 0 がレポートされます。

import flash.filesystem.File;
var rootDirs:Array = File.getRootDirectories();

for (var i:uint = 0; i < rootDirs.length; i++) {
    trace(rootDirs[i].nativePath);
}

この File オブジェクトで指定された場所にあるファイルまたはディレクトリを、destination パラメーターで指定された場所に移動します。

ファイルの名前を変更するには、そのファイルのディレクトリにある別の名前のファイルへのパスを指すように destination パラメーターを設定します。

移動処理によって、可能な場合には必要な親ディレクトリが作成されます。

パラメーター

関連する API エレメント

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolvePath("Apollo Test/test2.txt");

try  
{
    sourceFile.moveTo(destination, true);
}
catch (error:Error)
{
    trace("Error:" + error.message);
}

import flash.filesystem.File;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolvePath("AIR Test/Results/test1.txt");

try 
{
    sourceFile.moveTo(destination, true);
}
catch (error:Error)
{
    trace("Error:" + error.message);
}

この File オブジェクトで指定された場所にあるファイルまたはディレクトリを、newLocation パラメーターで指定された場所に移動する処理を開始します。

ファイルの名前を変更するには、そのファイルのディレクトリにある別の名前のファイルへのパスを指すように destination パラメーターを設定します。

移動処理によって、可能な場合には必要な親ディレクトリが作成されます。

パラメーター

関連する API エレメント

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolvePath("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolvePath("Apollo Test/test2.txt");

sourceFile.moveToAsync(destination, true);
sourceFile.addEventListener(Event.COMPLETE, fileMoveCompleteHandler);

function fileMoveCompleteHandler(event:Event):void 
{
    trace("Done.")
}

ファイルまたはディレクトリをごみ箱に移動します。

注意：回復可能なごみ箱フォルダーという概念をサポートしないオペレーティングシステムの場合、ファイルは直ちに削除されます。

関連する API エレメント

ファイルまたはディレクトリを非同期でごみ箱に移動します。

注意：回復可能なごみ箱フォルダーという概念をサポートしないオペレーティングシステムの場合、ファイルは直ちに削除されます。

関連する API エレメント

このファイル形式用としてオペレーティングシステムに登録されているアプリケーションで、ファイルを開きます。

AIR には、File.openWithDefaultApplication() メソッドで開けないファイルがあります。Windows では、特定のファイル形式のファイル（以下に示す特定の拡張子が付いたファイル）は開けません。Mac OS および Linux では、AIR は以下に指定した特定のアプリケーションで起動するファイルを開けないようにします。openWithDefaultApplication() メソッドを使用して、これらのファイルを開こうとすると、例外が発生します。ただし、ネイティブインストーラー（拡張デスクトッププロファイルアプリケーション）でインストールした AIR アプリケーションは、これらの制限を受けないので、すべての形式のファイルを開くことができます。

アプリケーションディレクトリのドキュメントは開けません。

次の表に、Windows で使用できないファイル拡張子と、Mac OS および Linux で使用できないアプリケーションを示します。

関連する API エレメント

import flash.filesystem.File;
import flash.net.FileFilter;

var file:File = File.documentsDirectory; 
var mp3Filter:FileFilter = new FileFilter("MP3 Files", "*.mp3"); 
file.browseForOpen("Open", [mp3Filter]); 
file.addEventListener(Event.SELECT, fileSelected); 
 
function fileSelected(e:Event):void 
{ 
    file.openWithDefaultApplication(); 
}

ファイルシステムにアクセスする権限を要求します。

path パラメーター（ストリング）に基づいて、この File オブジェクトのパスを基準とした相対的なパスを持つ新しい File オブジェクトを作成します。

path パラメーターとして相対パスまたは絶対パスを使用できます。

相対パスを指定した場合、指定した path は File オブジェクトのパスの末尾に「追加」されます。ただし、「..」を path で使用すると、File オブジェクトの子ではないパスが結果として返されることがあります。結果として得られる参照は、実際のファイルシステムの場所を参照していなくても構いません。

絶対ファイル参照を指定した場合、メソッドは、そのパスをポイントする File オブジェクトを返します。絶対ファイル参照では、ユーザーのオペレーティングシステムの有効なネイティブパス構文（Windows の「C:\\test」など）を使用する必要があります。URL（「file:///c:/test」など）は path パラメーターには使用しないでください。

結果として得られたパスは、すべて次のように正規化されます。

• すべての "."エレメントは無視されます。
• すべての ".."エレメントは、その親エントリを使用します。
• ".." 参照がファイルシステムのルートまたはアプリケーションの永続記憶領域のルートに達している場合、そのノードを越えることはありません。これは無視されます。

パスの区切り文字としては、常にスラッシュ（/）を使用してください。Windows では、バックスラッシュ（¥）文字も使用できますが、推奨されません。バックスラッシュ文字を使用すると、アプリケーションが他のプラットフォームで動作しない場合があります。

Linux では、ファイル名およびディレクトリ名の大文字と小文字は区別されます。

パラメーター

保留中の非同期処理がキャンセルされると、送出されます。

このイベントには、次のプロパティがあります。

非同期処理が完了すると、送出されます。

このイベントには、次のプロパティがあります。

getDirectoryListingAsync() メソッドを呼び出した結果、ディレクトリ一覧が得られると送出されます。

このイベントには、次のプロパティがあります。

関連する API エレメント

非同期ファイル処理中にエラーが発生すると、送出されます。

このイベントには、次のプロパティがあります。

ファイルシステムにアクセスする権限をアプリケーションから要求したときに送出されます。status プロパティの値を確認すると、権限が付与されたか拒否されたかを判定できます。

関連する API エレメント

操作がセキュリティ制約に違反していると、送出されます。

このイベントには、次のプロパティがあります。

ユーザーがファイルまたはディレクトリ参照ダイアログボックスからファイルまたはディレクトリを選択すると、送出されます。

このイベントには、次のプロパティがあります。

ユーザーが browseForOpenMultiple() メソッドの呼び出しによって開かれたダイアログボックスからファイルを選択すると、送出されます。

関連する API エレメント