The Close built-in extract file method closes the external file attached to the open extract file.
If the external file is not already open, this method is ignored.
Failure behavior
If the external file is not successfully closed, the Close method sets the Glb.Status built-in segment attribute to "*****".
Syntax
<<extract file>>::Close( retain : boolean = false, purge : boolean = false) : void
Owner
Any extract file.
Parameters
retain
When true, retains the external file after the calling report terminates.
purge
When true, purges the external file when the calling report terminates.
To summarize:
| Retain | Purge | Description |
|---|---|---|
| True | True | Empty the file but retain it. |
| True | False | Do not empty the file but retain it. |
| False | True or False | Do not retain the file. |