This documentation is archived and is not being maintained.

Array.Sort Method (Array, Array)

Sorts 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 IComparable implementation of each key.

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

public static function Sort(
	keys : Array, 
	items : Array
)

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.

ExceptionCondition
ArgumentNullException

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

RankException

The keys Array is multidimensional.

-or-

The items Array is multidimensional.

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.

InvalidOperationException

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.

Each key 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 the Length of keys; in the worst case it is an O(n ^ 2) operation.

The following 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.

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

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, 1.1, 1.0
Show: