Set Screensaver Settings
Modifies screen saver settings for the local computer.
Modifications made to screen saver settings using this Object will not take effect until the computer is re-started.
Privileges
Normal
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Screensaver | String | Yes | Option to set the screensaver to None, 3D Text, or Blank. |
| Wait | Number | Yes | Number of minutes to wait before the screensaver is activated. |
| Display Login Screen on Resume | Boolean | Yes | Boolean indicator to display login screen. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Screensaver | String | Yes | Set device screensaver to none, 3D text or blank. |
| Wait | Number | Yes | Set the amount of time in minutes before the screensaver will be displayed. |
| Display Login Screen on Resume | Boolean | Yes | Optionally display the device login screen when resuming. |