Edit

Share via


UnmanagedMemoryStream.Position Property

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.

Gets or sets the current position in a stream.

public override long Position { get; set; }

Property Value

The current position in the stream.

Exceptions

The stream is closed.

The position is set to a value that is less than zero, or the position is larger than Int32.MaxValue or results in overflow when added to the current pointer.

Remarks

When a stream is initialized, this property is set to zero.

Although you can set the position of the stream beyond the stream's capacity, you will not be able to access that area using the Read and Write methods. Read will return 0 and Write will throw a NotSupportedException. This support is primarily for design and code compatibility with basic stream operations.

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 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 2.0, 2.1
UWP 10.0