List-Management

<< Click to Display Table of Contents >>

Navigation:  3. Script Language > Arrays and Data-Structures > LST. - List Arrays > List-Management >

List-Management

LST.End. - Release Memory reserved for a List-Array

Previous Top Next


MiniRobotLanguage (MRL)

 

LST.End

Release Memory and destroy handle from List-Array

 

 

Intention

 

When a new list array is created using the command:

LST.New|$$LST

a handle (or key) is generated for that list array.

However, this also allocates memory, which increases as more elements are added to the list array.

If you want to free this memory at the end of the script or at any other time, and invalidate the handle, you should use the

LST.End|$$LST

command. This command releases the memory occupied by the list array and automatically deletes all list elements without any confirmation.

 

Syntax

 

 

LST.End|P1[|P2]

 

 

Parameter Explanation

 

P1 - (Variable) This Variable mus contain a valid Handle of a List-Array.

P2 - (Variable,optional) This Variable will return a result, that may be "0" or an error code. In most cases you do not need to specify P2.

 

 

Example

 

'***********************************

' LST.-Sample

'***********************************

LST.New|$$LST

DBP.New List created with this Handle: $$LST

LST.End|$$LST

DBP.List with this Handle: $$LST deleted and Memory returned to the System.

ENR.

 

 

 

 

Remarks

 

-

 

 

Limitations:

There are no limitations on the number of list arrays.

 

 

See also: