Array.Clear

Removes all items in an existing array.

Syntax

function Array.Clear(AArray: array): integer

Description

Sets the length of the array to 0, removing all items.

AArray holds a previously created array of any length.

The Return Value is 0.

Example

execute UDSBlock returns (length_value integer)

as

begin

  /* create an array with 3 elements */

  array_value = Array.Create('zero', 'one', 'two');

  length_value = Array.Length(array_value);

  suspend; /* returns 3 */

  Array.Clear(array_value);

  length_value = Array.Length(array_value);

  suspend; /* returns 0 */

end