IsSorted

Description

The IsSorted() method tests if the stored array is sorted in ascending order. If a ColumnIndex argument is provided and the array is jagged or multi-dimensional, it will test if the aray is sorted by the values in that column.

Note

IsSorted will raise an error if the array is more than two dimensions deep.

Syntax

expression.IsSorted([ColumnIndex])

Parameters

Name: ColumnIndex
Type: Long
Necessity: Optional
Description: The index of the column to be to be used when determining if the entries are in order. Only used in multi-dimensional or jagged arrays with a depth of 2.

Returns

Type: Boolean
Description: True if the array is sorted, False if not.

Example

Public Sub IsSortedExample()
    Dim result As Boolean
    Dim MyArray As BetterArray
    Set MyArray = New BetterArray

    MyArray.Push 1, 4, 2, 5, 3, 6
    result = MyArray.IsSorted
    Debug.Print result
    ' expected output:
    ' result is False

    MyArray.Clear
    MyArray.Push 1, 2, 3, 4, 5, 6
    result = MyArray.IsSorted
    Debug.Print result
    ' expected output:
    ' result is True
End Sub

Back to Docs