php8.5
Home/ Manual/ oci8 / ocilob/ OCILob::erase

OCILob::erase

PHP function Edit on GitHub ✎

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

Erases a specified portion of the internal LOB data

Description

OCILob::erase(int|null $offset = null, int|null $length = null): int|false

Erases a specified portion of the internal LOB data starting at a specified offset. If called without parameters, it erases all LOB data.

For BLOBs, erasing means that the existing LOB value is overwritten with zero-bytes. For CLOBs, the existing LOB value is overwritten with spaces.

Parameters

offset
length

Return Values

Returns the actual number of characters/bytes erased Falseforfailure.

Changelog

VersionDescription
8.0.0, PECL OCI8 3.0.0offset and length are now nullable.
8.0.0, PECL OCI8 3.0.0The OCI-Lob class was renamed to OCILob to align with PHP naming standards.

See Also

Source: reference/oci8/ocilob/erase.xml · from the official PHP manual (php/doc-en)