Admin Production ni-theme
Current Publication

GetScreenSaver

LabWindows/CVI

GetScreenSaver

int GetScreenSaver (int *enabled, int *sleepTime);

Purpose

This function obtains the current configuration of the Windows ScreenSaver.

(Linux) This function is not supported.

Parameters

Output
Name Type Description
enabled int Returns a boolean value indicating whether or not the ScreenSaver is currently enabled. You may pass NULL for this parameter.
sleepTime int Returns the time, in seconds, after which the ScreenSaver will activate. The resolution of this value is 60s. You may pass NULL for this parameter.

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