shmop_read

共有メモリブロックからデータを読み取る

説明

string shmop_read(Shmop $shmop, int $offset, int $size)

shmop_read は、共有メモリブロックから文字列を読み取ります。

パラメータ

shmop

shmop_open 関数で作られた、共有メモリブロックの識別子。

offset

読み取りを始めるオフセット。 この値は 0 以上、かつ共有メモリセグメントの実際のサイズ以下でなければいけません。

size

読み取るバイト数。 この値は 0 以上、かつ offsetsize の合計値が、共有メモリセグメントの実際のサイズ以下でなければいけません。 0 を指定すると、shmop_size($shmid) - $start バイトを読み取ります。

戻り値

読み取ったデータを返します。 失敗した場合に false を返します

エラー / 例外

offsetsize が範囲外の値の場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.0.0 引数 shmop は、 Shmop クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソースを期待していました。
8.0.0 offsetsize が範囲外の値の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、E_WARNING が発生し、false を返していました。

例1 共有メモリブロックを読み取る

<?php
$shm_data = shmop_read($shm_id, 0, 50);
?>

この例は、共有メモリブロックから50バイトを読み取り、 データを $shm_data に格納します。

参考

  • shmop_write