9.206 STM_FILE_READ
注意: 9.1 組み込み関数の規則 利用オプション
この組み込み関数によって、指定のストリーム・ファイルからデータを読み取ります。このストリーム・ファイルは、STM_FILE_OPENによってあらかじめ開いています。
LineTerminatorオプションを指定してストリーム・ファイルを開いている場合、指定の行終了文字までのデータがSTM_FILE_READアクションによって戻されます。
LineTerminator=NONEオプションを指定してストリーム・ファイルを開いている場合、指定の戻りデータ・ブロックに収まる量のデータが STM_FILE_READアクションによって戻されます。
関連する組み込み関数：STM_FILE_OPEN、STM_FILE_CLOSE、STM_FILE_WRITE、 STM_FILE_WRITE_CTL
Line Terminatorの使用については、｢9.205 STM_FILE_OPEN ｣を参照してください。
引数
|
番号
|
タイプ
|
必須/任意
|
記述
|
最小長
|
最大長
|
最小小数桁数
|
最大小数桁数
|
|
1
|
N
|
必須
|
データの読み取り元ファイルのファイル番号(ファイル・ハンドル)
この番号は、STM_FILE_OPENによってストリーム・ファイルに割り当てられています。
|
1
|
3
|
0
|
0
|
|
戻り値
|
番号
|
タイプ
|
必須/任意
|
記述
|
最小長
|
最大長
|
最小小数桁数
|
最大小数桁数
|
|
1
|
A
|
必須
|
戻りデータ・ブロック1
このデータ・ブロックの長さまでのデータが戻されます。
|
1
|
制限なし
|
|
|
|
2
|
A
|
任意
|
戻りコード
OK = データは読み取られ、戻された
ファイルを開くときに行終了文字が指定された場合、指定の終了文字までのデータが戻されています。
ファイルを開くときにLineterminator=NONEが指定された場合、指定のデータ・ブロックにデータが戻されています。
OV = データ・オーバーフロー
行終了文字が開くときに指定され、データ・ブロックに収まる量のデータが戻されていますが、この行に指定された終了文字に到達するまでにまだデータが存在します。後続のSTM_FILE_READによって、指定の終了文字までの残りのデータが戻されます。
EF = ファイルの終わりに到達した
読み取ろうとしたが、読み取れるデータがありません。戻りデータ・ブロックには、ブランクが戻されます。
ER = エラーが発生した
|
2
|
2
|
|
|
|
3
|
A
|
任意
|
戻りデータ・ブロック2
|
1
|
制限なし
|
|
|
|
4
|
A
|
任意
|
戻りデータ・ブロック3
|
1
|
制限なし
|
|
|
|
5
|
A
|
任意
|
戻りデータ・ブロック4
|
1
|
制限なし
|
|
|
|
6
|
A
|
任意
|
戻りデータ・ブロック5
|
1
|
制限なし
|
|
|
|
7
|
A
|
任意
|
戻りデータ・ブロック6
|
1
|
制限なし
|
|
|
|
8
|
A
|
任意
|
戻りデータ・ブロック7
|
1
|
制限なし
|
|
|
|
9
|
A
|
任意
|
戻りデータ・ブロック8
|
1
|
制限なし
|
|
|
|
10
|
A
|
任意
|
戻りデータ・ブロック9
|
1
|
制限なし
|
|
|
|
11
|
A
|
任意
|
戻りデータ・ブロック10
|
1
|
制限なし
|
|
|
|
例
「9.205 STM_FILE_OPEN 」を参照してください。
