Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

ListBoxAddArray Function

Overview

The ListBoxAddArray function adds an array of items to a list box.

Syntax/Parameters

Syntax

int = ListBoxAddArray ( int id, string array );

Parameters

id

An int containing the control ID of a list box.

array

An array of strings to add to the list box. Empty strings are not added. The add continues from the first item (in position zero) to the last item.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

If the list box is created with the LBS_SORT style, the ListBoxAddArray function inserts the items into the appropriate spot alphabetically. If the sort option is not enabled, the item is added to the end of the list box.

Related Functions

Platform Support

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

Legato IDE, Legato Basic