GetRowOrder()

Summary

Gets the order of rows in an editor.

 

Syntax

sort_sequence = GetRowOrder(string editor_name)

 

Argument	Contents
editor_name	The name of the editor, or null for the current editor

 

Returns

An array of fieldname/direction pairs specifying the current order of rows in the editor. Each pair is an array of two elements: a field name in the editor's view and a string specifying whether the field is sorted Ascending or Descending. The first pair in the sort_sequence array specifies the primary sort key; the second pair specifies the secondary sort key, etc. A null return value indicates that the editor is displaying its rows in the natural order of its view and set.

 

Example

order = GetRowOrder()

If order = null then ShowMessage("The editor is not sorted.")

else ShowMessage("The primary sort key is " + order[1][1])

 

Error Codes

Error Type	Meaning
NotFound	The specified editor does not exist

 

See Also

Function	Summary
GetColumnArray()	Gets a list of the columns displayed in an editor
GetFirstRecord()	Finds the first record in a view or selection set based on a sort order
SetColumnArray()	Sets the columns displayed in an editor
SetRowOrder()	Sets the order in which rows appear in an editor