Array.Sort Method (Array, Array, IComparer)

July 28, 2014

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 specified IComparer.

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

public static void Sort(
	Array keys,
	Array items,
	IComparer comparer
)

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 keysArray.
-or-
null to sort only the keysArray.
comparer
Type: System.Collections.IComparer
The IComparer implementation to use when comparing elements.
-or-
null to use the IComparable implementation of each element.

ExceptionCondition
ArgumentNullException

keys is null.

RankException

The keysArray is multidimensional.

-or-

The itemsArray is multidimensional.

ArgumentException

items is not null, and the lower bound of keys does not match the lower bound of items.

-or-

items is not null, and the length of keys is greater than the length of items.

-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 null, and one or more elements in the keysArray do not implement the IComparable interface.

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

If comparer is null, each key in the keysArray 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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft