ssCore.App.setKioskMode

Enable or disable kiosk mode.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

flag - A flag that determines whether kiosk mode should be enabled or disabled. Valid values include: true and false.

skipRegMods - [Optional] - A flag that determines whether to skip the registry modifications when enabling kiosk mode. See notes for details. Valid values include: false and true.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.App.setKioskMode( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.App.setKioskMode( paramsObject );


Notes:

Kiosk mode disables the special Windows keys, Alt+F4, Ctrl+F4, Ctrl+Esc, Alt+Tab, Alt+Esc, PrtScr, Alt+PrtScr and Ctrl+Alt+Del. You would enable kiosk mode when you have to run your applications in unattended environments and don't want to allow users to access Windows.

The Ctrl+Alt+Del key sequence cannot be reliably disabled under Windows NT, 2000, XP, Vista or Windows 7 unless you are running from an account with administrator privileges. If you need to secure an application for kiosk mode on a systems where the login account does not have admin privileges, you will have to modifying the registry. See the article "Securing Windows for use as Dedicated Kiosks" on our web site (www.northcode.com) for detailed instructions on how to accomplish this.

Warning: If your system (or your application) crashes while you are in kiosk mode, some kiosk mode settings that are enabled by registry changes will remain in effect. You can easily undo this by creating a simple application that enables and disables kiosk mode or starting your kiosk application again and exiting normally. Andre Goliath created a simple Kiosk Reset tool you can download from our forums.

If you set the skipRegMods flag to "true" when enabling kiosk mode, SWF Studio will NOT attempt to make certain registry modifications. You would want to use this if you know you are running without admin privileges on Windows Vista and Windows 7 where attempting to modify the registry will result in a UAC prompt. SWF Studio will remember the state of skipRegMods when you enable kiosk mode so you don't have to set it to false when your disabling kiosk mode.


Examples:

ssCore.App.setKioskMode({flag:true});