MemoryStream.Capacity Property

Reference

Definition

Namespace:: System.IO

Assemblies:: mscorlib.dll, System.IO.dll

Assemblies:: netstandard.dll, System.Runtime.dll

Assembly:: System.IO.dll

Assembly:: System.Runtime.Extensions.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: MemoryStream.cs

Source:: MemoryStream.cs

Source:: MemoryStream.cs

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 number of bytes allocated for this stream.

public:
 virtual property int Capacity { int get(); void set(int value); };

public virtual int Capacity { get; set; }

member this.Capacity : int with get, set

Public Overridable Property Capacity As Integer

Property Value

Int32

The length of the usable portion of the buffer for the stream.

Exceptions

ArgumentOutOfRangeException

A capacity is set that is negative or less than the current length of the stream.

ObjectDisposedException

The current stream is closed.

NotSupportedException

set is invoked on a stream whose capacity cannot be modified.

Examples

This code example is part of a larger example provided for the MemoryStream class.

// Write the stream properties to the console.
Console::WriteLine( "Capacity = {0}, Length = {1}, "
"Position = {2}\n", memStream->Capacity.ToString(), memStream->Length.ToString(), memStream->Position.ToString() );

// Write the stream properties to the console.
Console.WriteLine(
    "Capacity = {0}, Length = {1}, Position = {2}\n",
    memStream.Capacity.ToString(),
    memStream.Length.ToString(),
    memStream.Position.ToString());

' Write the stream properties to the console.
Console.WriteLine( _
    "Capacity = {0}, Length = {1}, Position = {2}", _
    memStream.Capacity.ToString(), _
    memStream.Length.ToString(), _
    memStream.Position.ToString())

Remarks

Capacity is the buffer length for system-provided byte arrays. Capacity cannot be set to a value less than the current length of the stream.

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	1.1, 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	1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP	10.0

Share via