[Overview][Constants][Types][Classes][Procedures and functions][Variables] Reference for unit 'Classes' (#rtl)

TStream.Seek

Sets the current position in the stream

Declaration

Source position: line 0

public function TStream.Seek(

  Offset: LongInt;

  Origin: Word

):LongInt; virtual; overload;

function TStream.Seek(

  const Offset: Int64;

  Origin: TSeekOrigin

):Int64; virtual; overload;

Description

Seeksets the position of the stream to Offsetbytes from Origin. Origincan have one of the following values:

Constant Meaning
soFromBeginning Set the position relative to the start of the stream.
soFromCurrent Set the position relative to the beginning of the stream.
soFromEnd Set the position relative to the end of the stream.

Offsetshould be negative when the origin is SoFromEnd. It should be positive for soFromBeginningand can have both signs for soFromCurrent

This is an abstract method, which must be overridden by descendent classes. They may choose not to implement this method for all values of Originand Offset.

Errors

An exception may be raised if this method is called with an invalid pair of Offset,Originvalues. e.g. a negative offsetfor soFromBeginning.

See also

TStream.Position

  

The current position in the stream.