Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

DeleteListItem Function

Overview

The DeleteListItem function removes one or more specified items from a list.

Syntax/Parameters

Syntax

int = DeleteListItem ( var list[], int index, [int count] );

Parameters

list

A single-dimension array of any type.

index

A zero-based int specifying the index to delete from.

count

An optional int specifying the number of elements to delete. If omitted, the value is 1.

Return Value

Returns an int as ERROR_NONE or a formatted error code of failure.

Remarks

Items are shift from the bottom (or right) to delete the elements and then the end point is zero filled. The axis depth is used to mark the end point. If the index and count are outside the size of the array, an error will be returned.

Key name positions are not adjusted.

Related Functions

Platform Support

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

Legato IDE, Legato Basic