function PhpStreamWrapperInterface::stream_seek

Same name in other branches
  1. 9 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_seek()
  2. 10 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_seek()
  3. 11.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_seek()

Seeks to specific location in a stream.

This method is called in response to fseek().

The read/write position of the stream should be updated according to the offset and whence.

Parameters

int $offset: The byte offset to seek to.

int $whence: Possible values:

  • SEEK_SET: Set position equal to offset bytes.
  • SEEK_CUR: Set position to current location plus offset.
  • SEEK_END: Set position to end-of-file plus offset.

Defaults to SEEK_SET.

Return value

bool TRUE if the position was updated, FALSE otherwise.

See also

http://php.net/manual/streamwrapper.stream-seek.php

1 method overrides PhpStreamWrapperInterface::stream_seek()
LocalStream::stream_seek in core/lib/Drupal/Core/StreamWrapper/LocalStream.php
Seeks to specific location in a stream.

File

core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php, line 150

Class

PhpStreamWrapperInterface
Defines a generic PHP stream wrapper interface.

Namespace

Drupal\Core\StreamWrapper

Code

public function stream_seek($offset, $whence = SEEK_SET);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.