Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

ListBoxReplaceItem Function

Overview

The ListBoxReplaceItem function replaces the content of a specified list item.

Syntax/Parameters

Syntax

int = ListBoxReplaceItem ( int id, int index, string data );

Parameters

id

An int containing the control ID of a list box.

index

An int specifying the zero-based index of the item in the list box to be replaced.

data

A string representing the new data for the items specified by index.

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, ERROR_EOD if index specifies a position out of range, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

The ListBoxReplaceItem function will remove the selection from the item to be replaced if it was currently selected at the start of the operation.

Related Functions

Platform Support

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

Legato IDE, Legato Basic