SetScreenSaver
int SetScreenSaver (int enabled, int sleepTime, const char screenSaverPath[]);
Purpose
This function sets the current configuration of the Windows screen saver.
(Linux) This function is not supported.
Parameters
| Input | ||
| Name | Type | Description |
| enabled | int | Specify a nonzero value or select Yes in the function panel to enable the screen saver. Specify 0 or select No to disable the screen saver. |
| sleepTime | int | This parameter specifies the time, in seconds, after which the screen saver will activate. The resolution of this value is 60s. |
| screenSaverPath | const char[] | If you set the enabled parameter is a nonzero value, this parameter specifies the screen saver application (*.scr) path you want to use. If you set the enabled to 0, this parameter is ignored and may be NULL. |
Return Value
| Name | Type | Description |
| status | int | The status code that the function returns. 0 indicates success. A negative value indicates an error. This function may return a Programmer's Toolbox or UI Library error code. Call GetGeneralErrorString to obtain a text description of the error. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later