Mono Class Library: System.Array Overview | Members

System.Array.Sort Method

Sorts the specified pair of one-dimensional Array objects (one containing a set of keys and the other containing corresponding items) based on the keys in the first specified Array. [Edit]

[System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.MayCorruptInstance, System.Runtime.ConstrainedExecution.Cer.MayFail)]
public static void Sort (Array keys, Array items)

Parameters

keys
A one-dimensional Array that contains the keys to sort. [Edit]
items
A one-dimensional Array that contains the items that correspond to each of element of keys. Specify a null reference to sort only keys. [Edit]

Exceptions

TypeReason
ArgumentNullExceptionkeys is null. [Edit]
RankException

keys has more than one dimension.

-or-

items is not a null reference and has more than one dimension.

[Edit]
ArgumentException

items is not a null reference, and keys.GetLowerBound(0) does not equal items.GetLowerBound(0).

-or-

items is not a null reference, and keys.Length > items.Length.

[Edit]
InvalidOperationExceptionOne or more elements in keys that are used in a comparison do not implement the IComparable interface. [Edit]

Remarks

This version of Array.Sort(Array) is equivalent to Array.Sort(Array)(keys, items, keys.GetLowerBound(0), keys.Length, null).

Each key in keys is required to have a corresponding item in items. The sort is performed according to the order of keys . After a key is repositioned during the sort, the corresponding item in items is similarly repositioned. Only keys.Length elements of items are sorted. Therefore, items is sorted according to the arrangement of the corresponding keys in keys. If the sort is not successfully completed, the results are unspecified.

Each element of keys is required to implement the IComparable interface to be capable of comparisons with every other element in keys.

[Edit]

Example

This example demonstrates the Array.Sort(Array) method.

C# Example
using System;
public class ArraySortExample {
   public static void Main() {
      string[] strAry = { "All's", "well", "that", "ends", "well" };
      int[] intAry = { 3, 4, 0, 1, 2 };
      Console.Write( "The original string array is: " );
      foreach ( string str in strAry )
         Console.Write( str + " " );
      Console.WriteLine();
      Console.Write( "The key array is: " );
      foreach ( int i in intAry )
         Console.Write( i + " " );
      Console.WriteLine();
      Array.Sort( intAry, strAry );
      Console.Write( "The sorted string array is: " );
      foreach ( string str in strAry )
         Console.Write( str + " " );
   }
}

The output is

The original string array is: All's well that ends well
The key array is: 3 4 0 1 2
The sorted string array is: that ends well All's well

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0