streamWrapper::stream_seek

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

streamWrapper::stream_seek — Pesquisa uma localização específica em um fluxo

Descrição

public streamWrapper::stream_seek(int $offset, int $whence = SEEK_SET): bool

Este método é chamado em resposta a fseek().

A posição de leitura/escrita do fluxo deve ser atualizada de acordo com os parâmetros offset e whence.

Parâmetros

offset

O deslocamento no fluxo a pesquisar.

whence

Valores posssíveis:

  • SEEK_SET - Definir a posição igual ao número de bytes em offset.
  • SEEK_CUR - Definir a poisção igual à localização atual mais offset.
  • SEEK_END - Definir a poisção do fim do arquivo mais offset.

Note: A implementação atual nunca define o parâmetro whence para SEEK_CUR; em vez disso, tais pesquisas são internamente convertidas para pesquisas SEEK_SET.

Valor Retornado

Retorna true se a posição foi atualizada, false caso contrário.

Notas

Note:

Se não implementado, false é assumido como o valor de retorno.

Note:

Em caso de sucesso, streamWrapper::stream_tell() é chamado diretamente após a chamada a streamWrapper::stream_seek(). Se streamWrapper::stream_tell() falhar, o valor de retorno à função chamadora será definida para false.

Note:

Nem todas as operações de pesquisa no fluxo irão resultar na chamada a esta função. Fluxos PHP tem buffer de leitura habilitado por padrão (veja também stream_set_read_buffer()) e a pesquisa pode ser feita simplesmente movendo-se o ponteiro do buffer.

Veja Também

  • fseek() - Procura (seeks) em um ponteiro de arquivo