StringBuilder Constructor (Int32, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the StringBuilder class that starts with a specified capacity and can grow to a specified maximum.

Namespace:   System.Text
Assembly:  mscorlib (in mscorlib.dll)

public StringBuilder(
	int capacity,
	int maxCapacity
)

Parameters

capacity
Type: System.Int32

The suggested starting size of the StringBuilder.

maxCapacity
Type: System.Int32

The maximum number of characters the current string can contain.

Exception Condition
ArgumentOutOfRangeException

maxCapacity is less than one, capacity is less than zero, or capacity is greater than maxCapacity.

The capacity parameter defines the maximum number of characters that can be stored in the memory allocated by the current instance. Its value is assigned to the Capacity property. If the number of characters to be stored in the current instance exceeds this capacity value, the StringBuilder object allocates additional memory to store them.

If capacity is zero, the implementation-specific default capacity is used.

The maxCapacity property defines the maximum number of characters that the current instance can hold. Its value is assigned to the MaxCapacity property. If the number of characters to be stored in the current instance exceeds this maxCapacity value, the StringBuilder object does not allocate additional memory, but instead throws an exception.

Notes to Callers:

In the.NET Framework 4 and the .NET Framework 4.5, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. This can occur particularly when you call the Append and AppendFormat methods to append small strings.

The following example demonstrates how to call the StringBuilder constructor with a specified capacity and maximum capacity.

int capacity = 255;
int maxCapacity = 1024;
StringBuilder stringBuilder = 
    new StringBuilder(capacity, maxCapacity);

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: