Sign in Join
FPDoc Onlineexperiment

TInputPipeStream.Seek function

Member of TInputPipeStreampublicIn unit Pipes

Set the current position of the stream.

Declaration

pascal
function Seek(const Offset: Int64; Origin: TSeekOrigin): Int64
 ; override

Arguments

Offset

Offset, in bytes, starting at Origin.

Origin

Where to start counting Offset bytes.

Function result

New position of the stream.

Description

Seek overrides the standard Seek implementation. Normally, pipe streams stderr are not seekable. The TInputPipeStream stream tries to provide seek capabilities for the following limited number of cases:

Origin=soFromBeginning
If Offset is larger than the current position, then the remaining bytes are skipped by reading them from the stream and discarding them.
Origin=soFromCurrent
If Offset is zero, the current position is returned. If it is positive, then Offset bytes are skipped by reading them from the stream and discarding them, if the stream is of type iosInput.

All other cases will result in a EPipeSeek exception.

Errors

An EPipeSeek exception is raised if the stream does not allow the requested seek operation.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.