Guardian Procedure Calls Reference Manual

FILE_PURGE_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
OSS Considerations
Example
Related Programming Manuals
Summary
The FILE_PURGE_ procedure deletes a disk file that is not open. When FILE_PURGE_ is executed,
the disk file name is deleted from the volume's directory, and any disk space previously allocated
to that file is made available to other files.
Syntax for C Programmers
#include <cextdecs(FILE_PURGE_)>
short FILE_PURGE_ ( const char *filename
,short length );
Syntax for TAL Programmers
error := FILE_PURGE_ ( filename:length ); ! i:i
Parameters
filename:length
input:input
STRING .EXT:ref:*, INT:value
specifies the name of the file to be purged. The value of filename must be exactly length
bytes long and must be a valid disk file name or DEFINE name. If the name is partially qualified,
it is resolved using the contents of the =_DEFAULTS DEFINE.
Returned Value
INT
A file-system error code that indicates the outcome of the call.
FILE_PURGE_ Procedure 473