System.IO.Stream.Seek Method

When overridden in a derived class, sets the position within the current stream.

Syntax

public abstract long Seek (long offset, SeekOrigin origin)

Parameters

offset
A byte offset relative to the origin parameter.
origin
A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.

Returns

The new position within the current stream.

Exceptions

TypeReason
NotSupportedExceptionThe stream does not support seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedExceptionThe stream is closed.
System.IO.IOExceptionAn I/O error has occurred.

Remarks

Use the Stream.CanSeek property to determine whether the current instance supports seeking.

If offset is negative, the new position is required to precede the position specified by origin by the number of bytes specified by offset. If offset is zero (0), the new position is required to be the position specified by origin. If offset is positive, the new position is required to follow the position specified by origin by the number of bytes specified by offset.

Classes derived from Stream that support seeking must override this method to provide the functionality described above.

Seeking to any location beyond the length of the stream is supported.

Requirements

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0