|
|
|
Allows an NCL procedure to delete an entire vartable, including entries and the vartable definition, to free storage.
&VARTABLE FREE ID=tablename
[ SCOPE={ PROCESS | REGION | SYSTEM | AOM } ]
Operands:
(Mandatory) Indicates the name of the table you wish to free. tablename must be the name of an existing vartable, within the specified scope.
An optional parameter, indicating the scope of the table you wish to free. Allowed values are:
Indicates the table is visible only to the NCL process that allocates it. This includes any nested or higher-level EXECuted procedures.
Indicates the table is visible to all NCL procedures executing in the current region. This includes any procedures executing in another window, if you have more than one window open.
Indicates that the table is visible to all NCL procedures executing in the same system.
Indicates the statement refers to a mirrored vartable. The mirrored copy of the vartable is also freed if AOM is started.
Note: SCOPE=AOM is available only if your region includes Automation Services products.
Examples: &VARTABLE FREE
&VARTABLE FREE ID=MYTABLE
This example frees the private table called MYTABLE.
&VARTABLE FREE ID=RTABLE SCOPE=REGION
This example frees a table in the current region called RTABLE, if it exists.
Return Codes:
System variable &ZFDBK is set after an &VARTABLE FREE statement to indicate the result of the operation:
The table was freed successfully.
No table with this name exists within this scope.
SCOPE=AOM table was in use at the exact time the deletion of the mirrored copy was attempted. The table remains allocated.
&ZFDBK value 20 is possible with AOM tables only. If this happens, the NCL procedure should delay for approximately one second and try again.
Note:
Syntax errors in a &VARTABLE FREE statement will cause the NCL procedure to terminate.
| Copyright © 2009 CA. All rights reserved. |
|