Guardian Procedure Calls Reference Manual (G06.25+)
Guardian Procedure Calls (P)
Guardian Procedure Calls Reference Manual—522629-013
12-270
PURGE Procedure (Superseded by FILE_PURGE_
Procedure )
[8:11] file-id (blank-fill)
Temporary Disk File
[0:3] $
volname (blank-fill)
or
\
sysnum volname (blank-fill)
[4:11] #
temporary-file-id
Condition Code Settings
< (CCL) indicates that the PURGE failed (call FILEINFO or FILE_GETINFO_).
Note, however, that in the case of a disk free-space error (such as file-
system errors 52, 54, 58), the file is purged, and an error returns.
= (CCE) indicates that the file purged successfully.
> (CCG) indicates that the device is not a disk.
Considerations
•
Purge failure
If PURGE fails, the reason for the failure can be determined by calling FILEINFO
or FILE_GETINFO_, passing -1 as the
filenum parameter.
•
Purging a file audited by the Transaction Management Facility (TMF)
If the file is a file audited by TMF and there are pending transaction-mode record
locks or file locks, any attempt to purge that file fails with file error 12, whether or
not openers of the file still exist.
When an audited file is purged, all corresponding dump records are deleted from
the TMF catalog. If TMF is not active, attempts to purge an audited file fail with
file-system error 82.
•
Purging a partitioned file
When you purge the primary partition of a partitioned file, the file system
automatically purges all the other partitions located anywhere in the network that
are marked as secondary partitions. A secondary partition is marked as such if it
created at the same time as the primary partition.
•
Security consideration
File purging normally is performed in a logical fashion; the data is not necessarily
overwritten or erased, but rather pointers are changed to show the data to be
absent. For security reasons, you might want to set the CLEARONPURGE flag for
a file, using either function 1 of the SETMODE procedure or the File Utility
Program SECURE command. Either way, this option causes all data to be
physically erased (overwritten with zeros) when the file is purged.