Stream.Seek(Int64, SeekOrigin) Stream.Seek(Int64, SeekOrigin) Stream.Seek(Int64, SeekOrigin) Stream.Seek(Int64, SeekOrigin) Method

Definition

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

public:
 abstract long Seek(long offset, System::IO::SeekOrigin origin);
public abstract long Seek (long offset, System.IO.SeekOrigin origin);
abstract member Seek : int64 * System.IO.SeekOrigin -> int64
Public MustOverride Function Seek (offset As Long, origin As SeekOrigin) As Long

Parameters

offset
Int64 Int64 Int64 Int64

A byte offset relative to the origin parameter.

origin
SeekOrigin SeekOrigin SeekOrigin SeekOrigin

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

Returns

The new position within the current stream.

Exceptions

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

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.

Applies to

See Also