Array.Sort(StringArray, Array) Method

 Top 

Description

Sorts the calling Array in ascending order, reordering all input StringArray and Array arguments in order to maintain the relative positions of the array elements.

 

This method has been Deprecated. Please use Array.SortAscending or StringArray.SortAscending instead.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

 

Method Signature

Array.Sort(

StringArray stringArrayArgument,

Array arrayArgument)

 

 

Arguments

stringArrayArgument

Description:

StringArray to be reordered when the calling Array is sorted.

Repeatable:

0 to Unlimited times

 

 

arrayArgument

Description:

Array to be reordered when the calling Array is sorted.

Repeatable:

0 to Unlimited times

 

 

 

Return Value

Type:

number

 

 

Returns the number of rows in the calling Array.

 

Syntax

myVariable1 = myArray1.Sort(myStringArray1, myArray2);

 

 

Example 1

This example demonstrates how to use the Array.Sort method to sort a numerical Array in increasing order.

 

// Create Objects

Array ArrayToSort;

Array SortedArray;

 

// Initialize the ArrayToSort

ArrayToSort = {9, 0, 4, 1, 5, 6, 8, 2, 7, 3};

 

// Copy ArrayToSort into SortedArray, and sort the copy

SortedArray = ArrayToSort;

SortedArray.Sort();

 

// Report out the sorted Arrays

For i = 0 to ArrayToSort.Dimension-1 step 1;

 Report ArrayToSort[i]<3,0>, SortedArray[i]<3,0>;

End;

 

 

Output Report:

 

ArrayToSort

SortedArray

9

0

0

1

4

2

1

3

5

4

6

5

8

6

2

7

7

8

3

9

 

 

 

 

 

See also

Array Object

Array.Sort

Matrix, Array, and Variable Math Guide