メソッドの概要

返却値の型 メソッド名
Boolean close ()
ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。
Boolean eachLine (Function callback)
1 行ずつ読み込み、callback を呼び出します。callback には読み出された行の内容と、そのインデックス(行番号)が渡されます。
Boolean markSupported ()
このストリームが mark() オペレーションをサポートするかどうかを判定します。
Boolean mark (Number readAheadLimit)
ストリームの現在位置にマークを設定します。
String readLine ()
テキスト行を読み込みます。
Number read (Number[] [cbuf], Number [off], Number [len])
配列の一部に文字を読み込みます。
Boolean ready ()
このストリームが読み込み可能かどうかを判定します。
Boolean reset ()
ストリームをリセットします。
Number skip (Number n)
文字をスキップします。
Boolean transferTo (TextWriter writer, Number [transSize])
自身のストリームから読み込んだデータをすべて writer に書き込みます。

メソッドの詳細

Boolean close ()
ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。
返却値
Boolean
Boolean 失敗した場合は false。
Boolean eachLine (Function callback)
1 行ずつ読み込み、callback を呼び出します。callback には読み出された行の内容と、そのインデックス(行番号)が渡されます。
例:関数を渡せるので以下のような使い方をすることができます。
 reader.eachLine(function(line, index) {
   // 1行読み込まれるごとに呼ばれます.
   Debug.print(line);
 });
 
パラメータ
callback : Function
コールバック関数
返却値
Boolean
Boolean 失敗した場合は false。
Boolean markSupported ()
このストリームが mark() オペレーションをサポートするかどうかを判定します。
返却値
Boolean
Boolean このストリームが mark オペレーションをサポートする場合に限り true。
Boolean mark (Number readAheadLimit)
ストリームの現在位置にマークを設定します。
パラメータ
readAheadLimit : Number
ストリームの現在位置
返却値
Boolean
Boolean 失敗した場合は false。
String readLine ()
テキスト行を読み込みます。
読み込むテキスト行の長さに制限はありません。
返却値
String
String 行の内容を含む文字列、ただし行の終端文字は含めない。ストリームの終わりに達している場合は null。
Number read (Number[] [cbuf], Number [off], Number [len])
配列の一部に文字を読み込みます。 オフセット off と 読み込むバイト数 len が省略された場合は文字を読み込み、それをバッファ配列 b に格納します。
更にバッファ配列 bも省略された場合は単一の文字を読み込みます。
パラメータ
[cbuf] : Number[]
入力ストリーム
[off] : Number
オフセット
[len] : Number
読み込むバイト数
返却値
Number
Number 読み込まれた文字数。(引数省略時は0 ~ 65535 (0x00-0xffff) の範囲の整数としての、読み込まれた文字。)ストリームの終わりに達した場合は -1 。失敗した場合は null。
Boolean ready ()
このストリームが読み込み可能かどうかを判定します。
返却値
Boolean
Boolean 次の read() が入力をブロックしないことが確実な場合は true、そうでない場合は false。false が返されても、次の読み込みが確実にブロックするというわけでない。失敗した場合は null。
Boolean reset ()
ストリームをリセットします。
返却値
Boolean
Boolean 失敗した場合は false。
Number skip (Number n)
文字をスキップします。
パラメータ
n : Number
スキップする文字数
返却値
Number
Number 実際にスキップした文字数。失敗した場合は null。
Boolean transferTo (TextWriter writer, Number [transSize])
自身のストリームから読み込んだデータをすべて writer に書き込みます。
transSize が指定されている場合、tranSize バイト毎転送を行います。transSize が大きいほど高速ですが、その分メモリを消費します。
パラメータ
writer : TextWriter
書き込み先
[transSize] : Number
転送させたいバイト数
返却値
Boolean
Boolean 失敗した場合は false。