STF.getFolder()

Availability

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

Usage

STF.getFolder() : String

Parameters

None.

Returns

A string.; 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; Returns the path to the screen saver. This function has been replaced. Use STF.getSpecialFolder() instead.

Example

The following example returns the path to the folder containing the screen saver.

var folderPath:String;

//define the callback
function onGetFolderReturn(returnValue:String){
	folderPath = returnValue;
}

//register callback
STF.registerCallBack("getFolder", onGetFolderReturn, this);

STF.getFolder();

See Also

STF.getSpecialFolder()