STF.deleteFile()

Availability

Flash MX 2004 or 8 swf w/ ScreenTimeScreenSaver component + ScreenTime 3.0 / 3.0

Usage

STF.deleteFile(fileName:String) : Boolean

Parameters

fileName - Name (including the path) of the file to delete. If a fully qualified path is not specified, the working directory is used.

Returns

A boolean.; This value is returned as a parameter to the registered callback. See the example below or STF.registerCallBack() for more information on return variable handling.

Description

Method; Deletes the specified file.

Example

The following example deletes a file from the working directory.

var success:Boolean;
// callback function
onDeleteFileReturn = function(returnValue:Boolean) { 
	success = returnValue;
}
STF.registerCallBack("deleteFile", onDeleteFileReturn, this); // register callback function
STF.deleteFile("File.txt");

See Also

STF.copyFile(), STF.createShortcut(), STF.downloadFile(), STF.listFiles(), STF.renameFile(), STF.getSpecialFolder()