Php/docs/eventbuffer.searcheol
EventBuffer::searchEol
(PECL event >= 1.5.0)
EventBuffer::searchEol — Scans the buffer for an occurrence of an end of line
Description
public
EventBuffer::searchEol
([
int
$start
= -1
[,
int
$eol_style
=
EventBuffer::EOL_ANY
]] ) : mixed
Scans the buffer for an occurrence of an end of line specified by
eol_style
parameter . It returns numeric position of the string, or FALSE if the
string was not found.
If the
start
argument is provided, it represents the position at which the search should
begin; otherwise, the search is performed from the start of the string. If
end
argument provided, the search is performed between start and end buffer
positions.
Return Values
Returns numeric position of the first occurance of end-of-line symbol in
the buffer, or FALSE if not found.
Warning
This function may
return Boolean FALSE, but may also return a non-Boolean value which
evaluates to FALSE. Please read the section on Booleans for more
information. Use the ===
operator for testing the return value of this
function.
