STF.deleteFolder()

Availability

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

Usage

STF.deleteFolder(folderName:String) : Boolean

Parameters

folderName - Name (including the path) of the folder 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 folder.

Example

The following example deletes a folder.

// callback function
onDeleteFolderReturn = function(returnValue:Boolean) { 
	success = returnValue;
}
// register callback function
STF.registerCallBack("deleteFolder", onDeleteFolderReturn, this); 
STF.deleteFolder("/Subfolder");

See Also

STF.createFolder(), STF.getSpecialFolder()