RtfwSetWindowsIdleDetection

RtfwSetWindowsIdleDetection configures whether or not the RTX64 Subsystem disables Windows idle detection power optimization while the RTX64 Subsystem is running. When Windows idle detection is disabled, power state transitions are prevented on Windows processors, because they can cause loss of determinism on real-time processors.

Syntax

bool RtfwSetWindowsIdleDetection(
    bool disableIdleDetection
);

Parameters

disableIdleDetection

If true, Windows idle detection power optimization is disabled while the RTX64 Subsystem is running. Otherwise it is not disabled.

Return Value

The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.

Remarks

If the Subsystem is running when this function succeeds, the last error is set to RT_ERROR_RESTART_SUBSYSTEM. RtfwRestartRequired will report that the RTX64 Subsystem must be restarted.

NOTE: The RTX64 Subsystem must be restarted for the change to take effect.

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib