ArrayClear()
Clears the records from an array.
Syntax
[returnfield =] [callproc] arrayclear(arr)
returnfield
Specifies the name of field to which the result is returned. Integer.
You must include a value for returnfield if you omit the callproc keyword; otherwise it is optional.
arr
Specifies tghe name of an array
Description
The arrayclear() built-in procedure removes all array records, including any marked as deleted. The rows are completely removed, as with the arrayremoverow() function (described later in this chapter).
The procedure returns 0 on success or a non-zero number on failure. Failure occurs only in rare circumstances, such as trying to pass the procedure a parameter that is not an array.
Example
To clear all records from the array emparray:
callproc arrayclear (emparray);
Last modified date: 08/28/2024