Stream.Seek Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
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
)
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
| Exception | Condition |
|---|---|
| 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
Windows Phone OS
Supported in: 8.1, 8.0, 7.1, 7.0
Platforms
Windows Phone