MemoryStream.Seek(Int64, SeekOrigin) Method
Definition
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 stream to the specified value.
public:
override long Seek(long offset, System::IO::SeekOrigin loc);
public override long Seek (long offset, System.IO.SeekOrigin loc);
override this.Seek : int64 * System.IO.SeekOrigin -> int64
Public Overrides Function Seek (offset As Long, loc As SeekOrigin) As Long
Parameters
- offset
- Int64
The new position within the stream. This is relative to the loc
parameter, and can be positive or negative.
- loc
- SeekOrigin
A value of type SeekOrigin, which acts as the seek reference point.
Returns
The new position within the stream, calculated by combining the initial reference point and the offset.
Exceptions
Seeking is attempted before the beginning of the stream.
offset
is greater than Int32.MaxValue.
The current stream instance is closed.
Examples
This code example is part of a larger example provided for the MemoryStream class.
// Set the stream position to the beginning of the stream.
memStream->Seek( 0, SeekOrigin::Begin );
// Set the position to the beginning of the stream.
memStream.Seek(0, SeekOrigin.Begin);
' Set the stream position to the beginning of the stream.
memStream.Seek(0, SeekOrigin.Begin)
Remarks
This method overrides Stream.Seek.
Seeking to any location beyond the length of the stream is supported.
Do not use the Seek method to determine the new position in the stream if the MemoryStream was initialized with a non-zero offset. If you do, Seek will return an inaccurate value. Instead, use the Position property to get the new position of the stream.