STF.getDesktopFolder()

Availability

Flash AS2.0 SWF w/ ScreenTimeScreenSaver component + ScreenTime 3.0 / 3.0

Usage

STF.getDesktopFolder() : 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 Desktop folder. This function has been replaced. Use STF.getSpecialFolder() instead.

Example

The following example returns the path to the desktop.

var desktopFolder:String;

//define the callback
function onGetDesktopFolderReturn(returnValue:String) {
	desktopFolder = returnValue;
}

//register callback
STF.registerCallBack("getDesktopFolder", onGetDesktopFolderReturn, this);

STF.getDesktopFolder();

See Also

STF.getSpecialFolder()