FileStream  - AS3

會傳回可在輸入緩衝區中讀取之資料的位元組數。 使用者程式碼必須呼叫 bytesAvailable，確定在嘗試以其中一種讀取方法進行讀取之前，具有足夠的資料。

資料的位元組順序，會是 Endian 類別的 BIG_ENDIAN 或 LITTLE_ENDIAN 常數。

指定當使用 readObject() 或 writeObject() 方法來寫入或讀取二進位資料時，要使用 AMF3 或 AMF0 格式。

此值是來自於 ObjectEncoding 類別的常數。根據預設會使用 AMF3 格式。

相關 API 元素

檔案中目前的位置。

以下列任何方式修改此值：

• 當您明確設定屬性時
• 當讀取 FileStream 物件時 (使用其中一個讀取方法)
• 當寫入 FileStream 物件時

位置定義為 Number (而非單位)，以便支援大於 2³² 位元組長度的檔案。這個屬性的值一定是小於 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();
}

非同步讀取檔案時，從磁碟讀取的最小資料量。

這個屬性會指定非同步串流嘗試從目前位置開始讀取的資料量。會根據檔案系統分頁大小，以區塊方式讀取資料。因此，若在 8KB (8192 位元組) 的電腦系統上將 readAhead 設定為 9,000，執行階段每次會預先讀取 2 個區塊，亦即 16384 個位元組。這個屬性的預設值為 infinity：根據預設，以非同步方式開啟並進行讀取的檔案會一直讀取至檔案結尾。

從讀取緩衝區中讀取資料，不會變更 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 事件，然後再關閉應用程式 (以確保資料寫入)。

您可以藉由呼叫 open() 或 openAsync() 方法重複使用 FileStream 物件。這會關閉與 FileStream 物件關聯的任何檔案，但物件不會傳送 close 事件。

針對以非同步方式開啟的 FileStream 物件 (使用 openAsync() 方法)，即使您為 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();

以同步方式開啟 FileStream 物件，並指向 file 參數所指定的檔案。

如果 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();

以非同步方式開啟 FileStream 物件，並指向 file 參數所指定的檔案。

如果 FileStream 物件已開啟，則呼叫此方法會在開啟之前先關閉檔案，而且不會針對先前開啟的檔案傳送進一步的事件 (包括 close)。

如果 fileMode 參數設定為 FileMode.READ 或 FileMode.UPDATE，一旦檔案開啟，AIR 就會將資料讀入輸入緩衝區，而且在資料讀入輸入緩衝區時會傳送 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();
}

會從檔案串流、位元組串流或位元組陣列讀取 Boolean 值。讀取單一位元組。若該位元組不為零，即傳回 true，否則傳回 false。

會從檔案串流、位元組串流或位元組陣列讀取具有正負號的位元組。

從檔案串流、位元組串流或位元組陣列，讀取 length 參數所指定的資料位元組數目。這些位元組會讀入由 bytes 參數指定的 ByteArray 物件中，從 offset 所指定的位置開始。

參數

會從檔案串流、位元組串流或位元組陣列讀取 IEEE 754 雙精度浮點數。

會從檔案串流、位元組串流或位元組陣列讀取 IEEE 754 單精度浮點數。

會從檔案串流、位元組串流或位元組陣列讀取具有正負號的 32 位元整數。

使用指定的字元集，從檔案串流、位元組串流或位元組陣列讀取指定長度的多位元組字串。

參數

相關 API 元素

從檔案串流、位元組串流或位元組陣列讀取物件並以 AMF 序列化格式編碼。

相關 API 元素

會從檔案串流、位元組串流或位元組陣列讀取具有正負號的 16 位元整數。

會從檔案串流、位元組串流或位元組陣列讀取無正負號的位元組。

會從檔案串流、位元組串流或位元組陣列讀取無正負號的 32 位元整數。

會從檔案串流、位元組串流或位元組陣列讀取無正負號的 16 位元整數。

從檔案串流、位元組串流或位元組陣列讀取 UTF-8 字串。會假定此字串的前置詞為無正負號的短整數，以指示以位元組為單位的長度。

這個方法類似於 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); 
}

會寫入 Boolean 值。 會根據 value 參數寫入單一位元組；如果為 true 則為 1，如果為 false 則為 0。

參數

會寫入位元組。 使用參數的較低 8 位元，而忽略其餘較高 24 位元。

參數

以 length 指定的長度，從指定的位元組陣列 bytes，將位元組序列從 offset 所指定的位元組 (使用從零開始的索引) 開始寫入檔案串流、位元組串流或位元組陣列。

如果省略 length 參數，便會使用 0 的預設長度，並從 offset 位置開始寫入整個緩衝區。如果也省略 offset 參數，便會寫入整個緩衝區。

如果 offset 或 length 參數超出範圍，這兩者便會固定至 bytes 陣列的開頭與結尾。

參數

會寫入 IEEE 754 雙精度 (64 位元) 浮點數。

參數

會寫入 IEEE 754 單精度 (32 位元) 浮點數。

參數

會寫入 32 位元的具有正負號整數。

參數

使用指定的字元集，將多位元組字串寫入檔案串流、位元組串流或位元組陣列。

參數

相關 API 元素

使用 AMF 序列化格式，將物件寫入檔案串流、位元組串流或位元組陣列。

參數

相關 API 元素

會寫入 16 位元整數。 使用參數的較低 16 位元，而忽略其餘較高 16 位元。

參數

會寫入 32 位元的無正負號整數。

參數

將 UTF-8 字串寫入檔案串流、位元組串流或位元組陣列。會先寫入 UTF-8 字串的長度 (以位元組為單位，16 位元整數)，後面緊接著表示字串之字元的位元組。

參數

會寫入 UTF-8 字串。 類似 writeUTF()，但是不以 16 位元長度的字做為字串前置詞。

參數

表示已藉由明確呼叫 close() 方法關閉串流。

這個事件具有下列屬性：

相關 API 元素

指出已到達串流結尾。

這個事件具有下列屬性：

相關 API 元素

表示非同步檔案 I/O 作業期間發生錯誤。

這個事件具有下列屬性：

指出緩衝資料已寫入檔案。

這個事件具有下列屬性：

指出串流上新資料的可用性。

這個事件具有下列屬性：