Skip to main content
.NET Framework Class Library
Stream..::.Seek Method

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

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Syntax
Public MustOverride Function Seek ( _
	offset As Long, _
	origin As SeekOrigin _
) As Long
public abstract long Seek(
	long offset,
	SeekOrigin origin
)
public:
virtual long long Seek(
	long long offset, 
	SeekOrigin origin
) abstract
abstract Seek : 
        offset:int64 * 
        origin:SeekOrigin -> int64 

Parameters

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

Return Value

Type: System..::.Int64
The new position within the current stream.
Exceptions
ExceptionCondition
IOException

An I/O error occurs.

NotSupportedException

The stream does not support seeking, such as if the stream is constructed from a pipe or console output.

ObjectDisposedException

Methods were called after the stream was closed.

Remarks

Use the 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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Microsoft is conducting an online survey to understand your opinion of the MSDN Web site. If you choose to participate, the online survey will be presented to you when you leave the MSDN Web site.

Would you like to participate?