Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

ListBoxInsertItem Function

Overview

The ListBoxInsertItem function inserts an item to the list box at a specific position.

Syntax/Parameters

Syntax

int = ListBoxInsertItem ( int id, int index, mixed value );

Parameters

id

An int containing the control ID of a list box.

index

An int containing the zero-based index of the position at which to insert the string. If index is -1, the string is added to the end of the list.

value

A string or

an int value to add to the list box. If the list box has the tab option set, the string can contain tab characters to mark the columns.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: 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 has the LBS_SORT option enabled, the ListBoxInsertItem function inserts the item at the specified index and the list box is not resorted. If the list box does not have the LBS_SORT style, the string is added to the end of the list. See the ListBoxAddItem function to add an item to the end of the list or the ListBoxLoadList function to load a list into a list box from a resource.

Related Functions

Platform Support

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

Legato IDE, Legato Basic