Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

ListBoxGetSelectIndex Function

Overview

The ListBoxGetSelectIndex function returns the selected item within a list box in single select mode, if available.

Syntax/Parameters

Syntax

int = ListBoxGetSelectIndex ( int id );

Parameters

id

An int containing the control ID of a list box.

Return Value

Returns an integer containing the zero-base index of the selected item, -1 if no item is selected, 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

This function support does not support multiple selection list boxes. See LBS_MULTISELECT for list boxes that support multiple item selection.

Related Functions

Platform Support

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

Legato IDE, Legato Basic