Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

ListBoxGetItemText Function

Overview

The ListBoxGetItemText function retrieves the text associated with a specific list box item.

Syntax/Parameters

Syntax

string = ListBoxGetItemText ( int id, int index );

Parameters

id

An int containing the control ID of a list box.

index

An int containing the zero-based index of the item from which to retrieve the text.

Return Value

Returns a string containing the item or an empty string on failure. An empty string does not necessarily indicate failure. Use the GetLastError function to retrieve error information.

Remarks

The size of the item text is limited to 65536. If the index parameter is out of range for the list box, the GetLastError function will return ERROR_EOD. If the id parameter contains an invalid control ID for the open dialog, the GetLastError function will return ERROR_RANGE. If no dialog is open, the GetLastError function will return ERROR_INVALID_HANDLE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic