This documentation is archived and is not being maintained.

List(Of T).Sort Method (Comparison(Of T))

Sorts the elements in the entire List(Of T) using the specified System.Comparison(Of T).

Namespace:  System.Collections.Generic
Assembly:  mscorlib (in mscorlib.dll)

Public Sub Sort ( _
	comparison As Comparison(Of T) _
Dim instance As List 
Dim comparison As Comparison(Of T)



Type: System.Comparison(Of T)

The System.Comparison(Of T) to use when comparing elements.


comparison is Nothing.


The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.

If comparison is provided, the elements of the List(Of T) are sorted using the method represented by the delegate.

If comparison is Nothing, an ArgumentNullException is thrown.

This method uses Array.Sort, which uses the QuickSort algorithm. This implementation performs an unstable sort; that is, if two elements are equal, their order might not be preserved. In contrast, a stable sort preserves the order of elements that are equal.

On average, this method is an O(n log n) operation, where n is Count; in the worst case it is an O(n ^ 2) operation.

The following code example demonstrates the Sort(Comparison(Of T)) method overload.

The code example defines an alternative comparison method for strings, named CompareDinosByLength. This method works as follows: First, the comparands are tested for Nothing, and a null reference is treated as less than a non-null. Second, the string lengths are compared, and the longer string is deemed to be greater. Third, if the lengths are equal, ordinary string comparison is used.

A List(Of T) of strings is created and populated with four strings, in no particular order. The list also includes an empty string and a null reference. The list is displayed, sorted using a Comparison(Of T) generic delegate representing the CompareDinosByLength method, and displayed again.

Imports System
Imports System.Collections.Generic

Public Class Example

    Private Shared Function CompareDinosByLength( _
        ByVal x As String, ByVal y As String) As Integer 

        If x Is Nothing Then 
            If y Is Nothing Then  
                ' If x is Nothing and y is Nothing, they're 
                ' equal.  
                Return 0
                ' If x is Nothing and y is not Nothing, y 
                ' is greater.  
                Return -1
            End If 
            ' If x is not Nothing... 
            If y Is Nothing Then 
                ' ...and y is Nothing, x is greater. 
                Return 1
                ' ...and y is not Nothing, compare the  
                ' lengths of the two strings. 
                Dim retval As Integer = _

                If retval <> 0 Then  
                    ' If the strings are not of equal length, 
                    ' the longer string is greater. 
                    Return retval
                    ' If the strings are of equal length, 
                    ' sort them with ordinary string comparison. 
                    Return x.CompareTo(y)
                End If 
            End If 
        End If 

    End Function 

    Public Shared Sub Main()

        Dim dinosaurs As New List(Of String)

        Console.WriteLine(vbLf & "Sort with generic Comparison(Of String) delegate:")
        dinosaurs.Sort(AddressOf CompareDinosByLength)

    End Sub 

    Private Shared Sub Display(ByVal lis As List(Of String))
        For Each s As String In lis
            If s Is Nothing Then
                Console.WriteLine("""{0}""", s)
            End If 
    End Sub 
End Class 

' This code example produces the following output: 


'Sort with generic Comparison(Of String) delegate: 


Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0