(Obsolete - System Library)
Description: This subroutine deletes an element from a list (single dimension array) and returns the modified list.
Returns: Array
Usage: Script
Format: \System\DeleteListItem(Array, Index)
Parameters:
Array {
array } { required } { no default
}
Any array
variable.
Index { numeric } { required } { no
default }
Any numeric
expression giving the element in the array to delete.
Comments: This subroutine has been superseded by the DeleteArrayItem function and is maintained for backwards compatibility only.
This subroutine is a member of the System Library, and must therefore be prefaced by "\System\", as shown in the "Format" section. If the application you are developing is a script application, the System variable must be declared in APPMOD.SRC and need not be prefaced by a backslash in the function call.
Example:
Data = System\DeleteListItem(Data { Array to use },
ArraySize(Data, 0) - 1
{ Element to delete });
This statement deletes the last element in the array called Data.
See Also: