RemoveSuperFile
STD.File.RemoveSuperFile
STD.File.RemoveSuperFile
File.RemoveSuperFile
RemoveSuperFile
( superfile, subfile
[ , delete ] [ , removecontents ])
superfile
A null-terminated string containing the logical name of the
superfile.
subfile
A null-terminated string containing the logical name of the
sub-file. This may be another superfile or a foreign file or
superfile.
delete
A boolean flag specifying whether to delete the
subfile from disk or just remove it from the
superfile list of files. If omitted, the
default is to just remove it from the superfile
list of files. This option should
not be used if the subfile is a foreign file or foreign
superfile.
removecontents
A boolean flag specifying whether the contents of a
subfile that is itself a superfile are
recursively removed.
Return:
Null.
The RemoveSuperFile function removes
the subfile from the list of files comprising the
superfile.
This function may be included in a superfile transaction.
Example:
SEQUENTIAL(
STD.File.StartSuperFileTransaction(),
STD.File.RemoveSuperFile('MySuperFile','MySubFile'),
STD.File.FinishSuperFileTransaction()
);