Clara-Doc - Method Reference
CTARR_Destructor
Description
This method will release all resources associated with an array and dispose of the array itself. The array will therefore no longer be usable. On return, the pointer to the array will be set to *Null.
A destructor performs garbage collection on behalf of a program. The reason for calling a constructor is to insure that your program will not run out of memory when it requires the creation of resources (such as arrays, linked lists and others). When your program no longer needs an object, it is well-advised to release the memory that this object occupies by calling its destructor.
A destructor performs garbage collection on behalf of a program. The reason for calling a constructor is to insure that your program will not run out of memory when it requires the creation of resources (such as arrays, linked lists and others). When your program no longer needs an object, it is well-advised to release the memory that this object occupies by calling its destructor.
Prototype
DCTARR_Destructor...
D PR 10I 0
D@This * Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of an array instance. This pointer MUST be obtained through a call to CTARR_Constructor. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The CTARR instance has been released. |
Once you call the destructor on an object, that object can no longer be accessed. The pointer to that object has been set to *Null. You can of course create a new instance by calling the constructor and retrieving the address of the object in the pointer variable.