Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

DataControlGetSortColumn Function

Overview

The DataControlGetSortColumn function returns the current sorted column index.

Syntax/Parameters

Syntax

int = DataControlGetSortColumn ( int id );

Parameters

id

An int containing the control ID of the data control.

Return Value

An int containing the zero-base index of the sorted column, -1 if no column is sorted or on failure. Use the GetLastError function to retrieve error information.

Remarks

If a column is not sorted, the return value will be -1. To sort a column, either use the DataControlSetSortColumn or enable sorting on a specific column using the DataControlSetColumnFlags function with one of the sort modes.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic