MemoryStream.Capacity 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 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
The length of the usable portion of the buffer for the stream.
Exceptions
A capacity is set that is negative or less than the current length of the stream.
The current stream is closed.
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.