Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

ListBoxGetSelectArray Function

Overview

The ListBoxGetSelectArray function retrieves all the text items in a multi-select list box item that are selected.

Syntax/Parameters

Syntax

string[] = ListBoxGetSelectArray ( int id );

Parameters

id

An int containing the control ID of a list box.

Return Value

Returns a string array containing all the selected items or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The LBS_MULTIPLESEL style must be set for this function to operate on the list box. The size of the each item’s text is limited to 1,048,575 bytes (although the Windows combo box class limits the size as well). Items that overflow the buffer will set an overflow error that can be retrieved by using the GetLastError function. Each overflow item will have the text replaced with “--OVERFLOW ITEM xx--”. 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