Array.Sort Method (Array, Array, Int32, Int32, IComparer)

Sorts a range of elements in a pair of one-dimensional Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first Array using the specified IComparer.

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

static member Sort : 
        keys:Array * 
        items:Array * 
        index:int * 
        length:int * 
        comparer:IComparer -> unit 

Parameters

keys
Type: System.Array
The one-dimensional Array that contains the keys to sort.
items
Type: System.Array
The one-dimensional Array that contains the items that correspond to each of the keys in the keys Array.
-or-
a null reference (Nothing in Visual Basic) to sort only the keys Array.
index
Type: System.Int32
The starting index of the range to sort.
length
Type: System.Int32
The number of elements in the range to sort.
comparer
Type: System.Collections.IComparer
The IComparer implementation to use when comparing elements.
-or-
a null reference (Nothing in Visual Basic) to use the IComparable implementation of each element.

ExceptionCondition
ArgumentNullException

keys is a null reference (Nothing in Visual Basic).

RankException

The keys Array is multidimensional.

-or-

The items Array is multidimensional.

ArgumentOutOfRangeException

index is less than the lower bound of keys.

-or-

length is less than zero.

ArgumentException

items is not a null reference (Nothing in Visual Basic), and the lower bound of keys does not match the lower bound of items.

-or-

items is not a null reference (Nothing in Visual Basic), and the length of keys is greater than the length of items.

-or-

index and length do not specify a valid range in the keys Array.

-or-

items is not a null reference (Nothing in Visual Basic), and index and length do not specify a valid range in the items Array.

-or-

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

InvalidOperationException

comparer is a null reference (Nothing in Visual Basic), and one or more elements in the keys Array do not implement the IComparable interface.

Each key in the keys Array has a corresponding item in the items Array. When a key is repositioned during the sorting, the corresponding item in the items Array is similarly repositioned. Therefore, the items Array is sorted according to the arrangement of the corresponding keys in the keys Array.

If comparer is a null reference (Nothing in Visual Basic), each key within the specified range of elements in the keys Array must implement the IComparable interface to be capable of comparisons with every other key.

You can sort if there are more items than keys, but the items that have no corresponding keys will not be sorted. You cannot sort if there are more keys than items; doing this throws an ArgumentException.

If the sort is not successfully completed, the results are undefined.

This method 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 length; in the worst case it is an O(n ^ 2) operation.

The following code example shows how to sort two associated arrays where the first array contains the keys and the second array contains the values. Sorts are done using the default comparer and a custom comparer that reverses the sort order. Note that the result might vary depending on the current CultureInfo.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft