BufferedStream.Seek(Int64, SeekOrigin) Method

Reference

Definition

Namespace:: System.IO

Assemblies:: netstandard.dll, System.Runtime.dll

Assembly:: System.IO.dll

Assembly:: System.Runtime.Extensions.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: BufferedStream.cs

Source:: BufferedStream.cs

Source:: BufferedStream.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the position within the current buffered stream.

public:
 override long Seek(long offset, System::IO::SeekOrigin origin);

public override long Seek(long offset, System.IO.SeekOrigin origin);

override this.Seek : int64 * System.IO.SeekOrigin -> int64

Public Overrides Function Seek (offset As Long, origin As SeekOrigin) As Long

Parameters

offset: Int64

A byte offset relative to origin.

origin: SeekOrigin

A value of type SeekOrigin indicating the reference point from which to obtain the new position.

Returns

Int64

The new position within the current buffered stream.

Exceptions

IOException

The stream is not open or is null.

NotSupportedException

The stream does not support seeking.

ObjectDisposedException

Methods were called after the stream was closed.

Remarks

If offset is negative, the new position will precede the position specified by origin by the number of bytes specified by offset. If offset is 0, the new position will be the position specified by origin. If offset is positive, the new position will follow the position specified by origin by the number of bytes specified by offset.

When a BufferedStream object is the base stream for a StreamReader object, calling the Seek method can cause the position of the stream to no longer match the position of the internal buffer in the reader. To reset the internal buffer, call the StreamReader.DiscardBufferedData method; however, this method slows performance and should be called only when absolutely necessary.

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

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.5, 1.6, 2.0, 2.1

Share via