SetScreenSaver

int SetScreenSaver (int enabled, int sleepTime, const char screenSaverPath[]);

Purpose

This function sets the current configuration of the Windows ScreenSaver.

Parameters

Input
Name Type Description
enabled integer This parameter specifies whether or not the ScreenSaver should be enabled.
sleepTime integer This parameter specifies the time, in seconds, after which the ScreenSaver will activate. The resolution of this value is 60s.
screenSaverPath const char [] If the enabled parameter is set to true, this parameter specifies the ScreenSaver application (*.scr) path you wish to use. If the enabled parameter is not set to true, this parameter is ignored and may be NULL.

Return Value

Name Type Description
status integer 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.