Destroys the Array object and frees its memory.
Result := Array_destroy(ArrayObject)
Parameters
| ArrayObject |
The Array object to use for the current operation. |
Return Value
True (1) if the Array was actually
destroyed,
or False (0) if the Array was not destroyed (see 1 below).
Remarks
The object will not be destroyed
if:
- The lock count for
ArrayObject is more than one. In this case, the lock count for ArrayObject
will be decreased by one, and the function returns false to indicate that
the object still exists.
- ArrayObject is NULL (0 or blank) - returns the empty string to indicate
an error.
Related
Array_new
Array
Examples
;Creates a new Array (of length 10)
myArray := Array_new(10)
;Destroys myArray and frees its memory
Result := Array_destroy(myArray)
Homepage | Containers