FileStream  - AS3

入力バッファーで読み取ることができるデータのバイト数を返します。読み取りメソッドを使用する前に、ユーザーコードで bytesAvailable を呼び出して、読み取るデータが十分にあることを確認します。

データのバイト順序（Endian クラスの BIG_ENDIAN 定数または LITTLE_ENDIAN 定数）です。

readObject() メソッドまたは writeObject() メソッドを使用してバイナリデータの書き込みまたは読み取りを行うときに AMF3 と AMF0 のどちらのフォーマットを使用するかを特定するために使用されます。

この値は、ObjectEncoding クラスの定数です。デフォルトでは、AMF3 フォーマットが使用されます。

関連する API エレメント

ファイルでの現在の位置です。

この値は、次のいずれかの方法で変更されます。

• プロパティを明示的に設定したとき
• (いずれかの読み取りメソッドを使用して) FileStream オブジェクトから読み取るとき
• FileStream オブジェクトに書き込むとき

位置は、2³² バイトを超える長さのファイルをサポートするために、（uint ではなく）Number として定義されます。このプロパティの値は、常に 2⁵³ 未満の整数です。この値を小数部を持つ数値に設定した場合は、最も近い整数に切り捨てられます。

ファイルを非同期で読み取ると、position プロパティを設定した場合、アプリケーションが読み取りバッファーに指定された位置から始まるデータの埋め込みを開始し、bytesAvailable プロパティが 0 に設定される可能性があります。読み取りメソッドを使ってデータを読み取る前に complete イベントを待つか、または読み取りメソッドを使う前に progress イベントを待って bytesAvailable プロパティをチェックします。

import flash.fileSystem.*;
import flash.utils.ByteArray;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory.resolvePath("Apollo Test/test.txt");
var stream:FileStream = new FileStream();
stream.addEventListener(Event.COMPLETE, readBytes);
stream.openAsync(sourceFile, FileMode.READ);

function readBytes(e:Event):void {
    var bytes:ByteArray = new ByteArray();
    trace("position 0:", stream.position); // 0
    bytes[0] = stream.readByte();
    trace("position 1:", stream.position); // 1
    fileStream.readBytes(bytes, stream.position, 4); 
    trace("position 2:", stream.position); // 5
    stream.close();
}

ファイルを非同期に読み取るときに、ディスクから読み取るデータの最小サイズ。

このプロパティは、現在の位置以降、非同期ストリームで読み取るデータの量を指定します。データは、ファイルシステムのページサイズに基づいて、ブロック単位で読み取られます。そのため、ページサイズが 8 KB（8,192 バイト）のコンピューターシステムで readAhead を 9,000 に設定すると、まずランタイムで 2 ブロック（16,384 バイト）が同時に読み取られます。このプロパティのデフォルト値は無限大です。デフォルトでは、読み取りのために非同期で開かれたファイルは、ファイルの末尾に達するまで読み取られます。

読み取りバッファーからデータを読み取っても、readAhead プロパティの値は変わりません。バッファーからデータを読み取ると、読み取りバッファーの空いた部分を埋めるために新しいデータが読み取られます。

readAhead プロパティは、同期的に開かれたファイルに対しては効果がありません。

データが非同期的に読み込まれると、FileStream オブジェクトは progress イベントを送出します。progress イベントのイベントハンドラーメソッドでは、(bytesAvailable プロパティを調べて) 必要なバイト数が利用可能であるかどうかを確認し、読み取りメソッドを使用して読み取りバッファーからデータを読み取ります。

import flash.filesystem.*;

var file:File = File.desktopDirectory.resolvePath("test.txt");
var fileStream:FileStream = new FileStream();
fileStream.readAhead = 100;
fileStream.addEventListener(ProgressEvent.PROGRESS, readProgressHandler)
fileStream.openAsync(file, FileMode.READ);
var results:ByteArray;

function readProgressHandler(event:ProgressEvent):void {
    if (fileStream.bytesAvailable >= 100) {
        fileStream.readBytes(results, 0, 100);
    }
}

FileStream オブジェクトを作成します。ファイルを開くには、open() メソッドまたは openAsync() メソッドを使用します。

関連する API エレメント

FileStream オブジェクトを閉じます。

close() メソッドを呼び出した後は、データの読み取りや書き込みを行うことはできません。ファイルを非同期で開いた（FileStream オブジェクトが openAsync() メソッドを使用してファイルを開いた）場合は、close() メソッドを呼び出すと、close イベントが送出されます。

アプリケーションを閉じると、アプリケーションの FileStream オブジェクトに関連付けられているすべてのファイルが自動的に閉じられます。ただし、アプリケーションを閉じる前に、非同期で開いた、書き込み保留中のデータのあるすべての FileStream オブジェクトについて closed イベントに登録することをお勧めします（これにより、データが確実に書き込まれます）。

FileStream オブジェクトを再利用するには、open() メソッドまたは openAsync() メソッドを呼び出します。これにより、FileStream オブジェクトに関連付けられたすべてのファイルが閉じられますが、このオブジェクトの close イベントは送出されません。

（openAsync() メソッドを使用して）非同期で開いた FileStream オブジェクトについては、その FileStream オブジェクトの close() イベントを呼び出し、そのオブジェクトを参照しているプロパティおよび変数を削除したとしても、保留中の処理があり、その完了のためのイベントハンドラーが登録されている場合は FileStream はガベージコレクションの対象になりません。つまり、参照されていない FileStream オブジェクトであっても、次のいずれかの可能性がある限りは存在し続けます。

• ファイルの読み取り処理で、ファイルの末尾に達していない（complete イベントが送出されていない）。
• 書き込み用の出力データがまだ存在し、出力関連のイベント（outputProgress イベント、ioError イベントなど）がイベントリスナーを登録している。

関連する API エレメント

import flash.filesystem.*;
import flash.events.Event;
            
var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.openAsync(file, FileMode.WRITE);
fileStream.writeUTFBytes("Hello");
fileStream.addEventListener(Event.CLOSE, fileClosed);
fileStream.close();

function fileClosed(event:Event):void {
    trace("closed");
}            

import flash.filesystem.*;
            
var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.WRITE);
fileStream.writeUTF("Hello");
fileStream.close();

file パラメーターで指定されたファイルを読み込み元として、FileStream オブジェクトを同期的に開きます。

FileStream オブジェクトが既に開いている場合、このメソッドを呼び出すと、ファイルは、いったん閉じてから開かれます。前に開かれていたファイルに対する追加のイベント（close を含む）は送出されません。

ファイルのロックをサポートするシステムでは、"書き込み" モードまたは "更新" モード（FileMode.WRITE または FileMode.UPDATE）で開かれたファイルは、そのファイルが閉じられない限り、読み取り可能になりません。

ファイルに対する操作を実行し終えたら、FileStream オブジェクトの close() メソッドを呼び出します。オペレーティングシステムによっては、並行して開いておけるファイルの数に制限があります。

パラメーター

関連する API エレメント

import flash.filesystem.*;

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

file パラメーターで指定されたファイルを読み込み元として、FileStream オブジェクトを非同期的に開きます。

FileStream オブジェクトが既に開いている場合、このメソッドを呼び出すと、ファイルは、いったん閉じてから開かれます。前に開かれていたファイルに対する追加のイベント（close を含む）は送出されません。

fileMode パラメーターが FileMode.READ または FileMode.UPDATE に設定されている場合、ファイルが開かれるとすぐに入力バッファーへのデータの読み取りが開始され、この読み取り処理中に progress イベントおよび open イベントが送出されます。

ファイルのロックをサポートするシステムでは、"書き込み" モードまたは "更新" モード（FileMode.WRITE または FileMode.UPDATE）で開かれたファイルは、そのファイルが閉じられない限り、読み取り可能になりません。

ファイルに対する操作を実行し終えたら、FileStream オブジェクトの close() メソッドを呼び出します。オペレーティングシステムによっては、並行して開いておけるファイルの数に制限があります。

パラメーター

関連する API エレメント

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

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.addEventListener(Event.COMPLETE, fileCompleteHandler)
fileStream.openAsync(file, FileMode.READ);

function fileCompleteHandler(event:Event):void {
    var str:String = fileStream.readMultiByte(fileStream.bytesAvailable, File.systemCharset);
    trace(str);
    fileStream.close();
}

ファイルストリーム、バイトストリームまたはバイト配列からブール値を読み取ります。 1 バイトが読み取られ、バイトがゼロ以外の場合は true、それ以外の場合は false が返されます。

ファイルストリーム、バイトストリームまたはバイト配列から符号付きバイトを読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から、length パラメーターで指定したデータバイト数を読み取ります。 このバイトは、bytes パラメーターで指定した ByteArray オブジェクトの、offset で指定された位置以降に読み込まれます。

パラメーター

ファイルストリーム、バイトストリームまたはバイト配列から IEEE 754 倍精度浮動小数点数を読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から IEEE 754 単精度浮動小数点数を読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から符号付き 32 bit 整数を読み取ります。

指定した文字セットを使用して、ファイルストリーム、バイトストリームまたはバイト配列から指定した長さのマルチバイトストリングを読み取ります。

パラメーター

関連する API エレメント

ファイルストリーム、バイトストリームまたはバイト配列から、AMF 直列化形式でエンコードされたオブジェクトを読み取ります。

関連する API エレメント

ファイルストリーム、バイトストリームまたはバイト配列から符号付き 16 bit 整数を読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から符号なしバイトを読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から符号なし 32 bit 整数を読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から符号なし 16 bit 整数を読み取ります。

ファイルストリーム、バイトストリームまたはバイト配列から UTF-8 ストリングを読み取ります。 このストリングには、バイト単位の長さを示す符号なし short が前に付いているものと見なされます。

このメソッドは、Java^® IDataInput インターフェイスの readUTF() メソッドによく似ています。

バイトストリームまたはバイト配列から UTF-8 の バイトのシーケンスを読み取り、ストリングを返します。

パラメーター

FileStream オブジェクトの position プロパティで指定された位置でファイルを切り捨てます。

position プロパティで指定された位置からファイルの末尾までのバイトが削除されます。ファイルは書き込み用に開かれている必要があります。

関連する API エレメント

import flash.filesystem.*;

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.UPDATE);
if (file.size > 100) {
    fileStream.position = 100;
    fileStream.truncate();
}
fileStream.close();

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.openAsync(file, FileMode.UPDATE);
trace("start", file.size)
if (file.size > 100) {
    fileStream.position = 100;
    fileStream.truncate();
}
fileStream.addEventListener(Event.CLOSE, fileClosed);
fileStream.close();
function fileClosed(event:Event):void {
    trace("closed", file.size); 
}

ブール値を書き込みます。value パラメーターに従って、1 バイトが書き込まれます。true の場合は 1、false の場合は 0 のいずれかが書き込まれます。

パラメーター

バイトを書き込みます。パラメーターの下位 8 bit が使用されます。上位 24 bit は無視されます。

パラメーター

指定したバイト配列（bytes）の offset（0 から始まるインデックス値）バイトから開始される length バイトのシーケンスをファイルストリーム、バイトストリームまたはバイト配列に書き込みます。

length パラメーターを省略すると、デフォルトの長さの 0 が使用され、offset から開始されるバッファー全体が書き込まれます。 offset パラメーターも省略した場合は、バッファー全体が書き込まれます。

offset または length パラメーターが範囲外の場合は、これらは bytes 配列の最初と最後に固定されます。

パラメーター

IEEE 754 倍精度（64 bit）浮動小数点数を書き込みます。

パラメーター

IEEE 754 単精度（32 bit）浮動小数点数を書き込みます。

パラメーター

32 bit 符号付き整数を書き込みます。

パラメーター

指定した文字セットを使用して、ファイルストリーム、バイトストリームまたはバイト配列にマルチバイトストリングを書き込みます。

パラメーター

関連する API エレメント

ファイルストリーム、バイトストリームまたはバイト配列に、AMF 直列化形式でオブジェクトを書き込みます。

パラメーター

関連する API エレメント

16 bit 整数を書き込みます。パラメーターの下位 16 bit が使用されます。上位 16 bit は無視されます。

パラメーター

32 bit 符号なし整数を書き込みます。

パラメーター

ファイルストリーム、バイトストリームまたはバイト配列に UTF-8 ストリングを書き込みます。 最初に UTF-8 ストリングの長さがバイト単位で 16 bit 整数として書き込まれ、その後にストリングの文字を表すバイトが続きます。

パラメーター

UTF-8 ストリングを書き込みます。writeUTF() と似ていますが、ストリングに 16 bit 長の接頭辞が付きません。

パラメーター

close() メソッドの明示的な呼び出しによってストリームが閉じられたことを示します。

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

関連する API エレメント

ストリームの終わりに達したことを通知します。

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

関連する API エレメント

非同期のファイル I/O 処理中にエラーが発生したことを示します。

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

バッファーに格納されたデータがファイルに書き込まれたことを通知します。

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

ストリーム上で新しいデータが使用可能になったことを通知します。

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