« OCILob::load
OCILob::rewind »

OCILob::read

(PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0)

OCILob::read — ラージオブジェクトの一部を読み込む

説明

public function OCILob::read(int $length): string|false

LOB の内部ポインタの現在位置から length バイト(BLOB) または、 length 文字 (CLOB) を読み込みます。

現在の LOB の内部ポイントから、 length バイト(BLOB) や length 文字(CLOB) を読み取った場合、 あるいはラージオブジェクトの終わりに達したとき、読み込みを停止します。 ラージオブジェクトの内部ポインタは、 読み込まれたバイト/文字数分だけシフトされます。

パラメータ

length

読み込むバイト数(BLOB) または文字数 (CLOB)。 大きな値を指定すると、1 MB に切り捨てられます。

戻り値

読み込んだ内容を表す文字列、失敗した場合に false を返します

変更履歴

バージョン 説明
8.0.0, PECL OCI8 3.0.0 OCI-Lob クラスは、 PHP の名前付けの規約に従って OCILob に名前が変更されました。
関連キーワード:
OCILob   length   ラージ   バイト   一部   read   内部   load   ポインタ   rewind   ポイント   読み込み   停止   シフト   文字数   履歴   規約   参考   write
関連する関数・ページ:
ocilob.write   ocilob.truncate   ocilob.load   ocilob.rewind   ocilob.save   ocilob.eof