RtfwGetWindowsIdleDetection

RtfwGetWindowsIdleDetection returns whether the wRTOS Subsystem disables Windows idle detection power optimization while the wRTOS 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

Copy
bool RtfwGetWindowsIdleDetection(
    [out]   bool * pDisableIdleDetection
);

Parameters

[out] pDisableIdleDetection

A pointer to a value that is set to TRUE if idle detection is disabled, FALSE if it is not disabled.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the value pointed to by pDisableIdleDetection invalid. Call GetLastError to obtain an error code.

Remarks

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwApi.h

RtfwApi.lib

See Also: