Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
  • None
User Action:
  • None
.NET Framework Class Library

StringBuilder.Equals Method (StringBuilder)

Returns a value indicating whether this instance is equal to a specified object.

Namespace:  System.Text
Assembly:  mscorlib (in mscorlib.dll)
Public Function Equals ( _
	sb As StringBuilder _
) As Boolean

Parameters

sb
Type: System.Text.StringBuilder

An object to compare with this instance, or null.

Return Value

Type: System.Boolean
true if this instance and sb have equal string, Capacity, and MaxCapacity values; otherwise, false.

The following code uses the Equals method to check whether two StringBuilder objects are equal. The method is called repeatedly after small changes are made to each object, and the results are displayed to the console.

Imports System.Text

Class Sample
   Public Shared Sub Main()
      Dim sb1 As New StringBuilder("abc")
      Dim sb2 As New StringBuilder("abc", 16)

      Console.WriteLine()
      Console.WriteLine("a1) sb1.Length = {0}, sb1.Capacity = {1}", sb1.Length, sb1.Capacity)
      Console.WriteLine("a2) sb2.Length = {0}, sb2.Capacity = {1}", sb2.Length, sb2.Capacity)
      Console.WriteLine("a3) sb1.ToString() = ""{0}"", sb2.ToString() = ""{1}""", _
                             sb1.ToString(),           sb2.ToString())
      Console.WriteLine("a4) sb1 equals sb2: {0}", sb1.Equals(sb2))

      Console.WriteLine()
      Console.WriteLine("Ensure sb1 has a capacity of at least 50 characters.")
      sb1.EnsureCapacity(50)

      Console.WriteLine()
      Console.WriteLine("b1) sb1.Length = {0}, sb1.Capacity = {1}", sb1.Length, sb1.Capacity)
      Console.WriteLine("b2) sb2.Length = {0}, sb2.Capacity = {1}", sb2.Length, sb2.Capacity)
      Console.WriteLine("b3) sb1.ToString() = ""{0}"", sb2.ToString() = ""{1}""", _
                             sb1.ToString(),           sb2.ToString())
      Console.WriteLine("b4) sb1 equals sb2: {0}", sb1.Equals(sb2))

      Console.WriteLine()
      Console.WriteLine("Set the length of sb1 to zero.")
      Console.WriteLine("Set the capacity of sb2 to 51 characters.")
      sb1.Length = 0
      sb2.Capacity = 51

      Console.WriteLine()
      Console.WriteLine("c1) sb1.Length = {0}, sb1.Capacity = {1}", sb1.Length, sb1.Capacity)
      Console.WriteLine("c2) sb2.Length = {0}, sb2.Capacity = {1}", sb2.Length, sb2.Capacity)
      Console.WriteLine("c3) sb1.ToString() = ""{0}"", sb2.ToString() = ""{1}""", _
                             sb1.ToString(),           sb2.ToString())
      Console.WriteLine("c4) sb1 equals sb2: {0}", sb1.Equals(sb2))
   End Sub  
End Class 
'The example displays the following output: 
'       a1) sb1.Length = 3, sb1.Capacity = 16 
'       a2) sb2.Length = 3, sb2.Capacity = 16 
'       a3) sb1.ToString() = "abc", sb2.ToString() = "abc" 
'       a4) sb1 equals sb2: True 
'        
'       Ensure sb1 has a capacity of at least 50 characters. 
'        
'       b1) sb1.Length = 3, sb1.Capacity = 50 
'       b2) sb2.Length = 3, sb2.Capacity = 16 
'       b3) sb1.ToString() = "abc", sb2.ToString() = "abc" 
'       b4) sb1 equals sb2: False 
'        
'       Set the length of sb1 to zero. 
'       Set the capacity of sb2 to 51 characters. 
'        
'       c1) sb1.Length = 0, sb1.Capacity = 50 
'       c2) sb2.Length = 3, sb2.Capacity = 51 
'       c3) sb1.ToString() = "", sb2.ToString() = "abc" 
'       c4) sb1 equals sb2: False

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.