RtfwGetEnabledProcessors

RtfwGetEnabledProcessors returns the total number of processors that are enabled on the system.

Syntax

Copy

bool RtfwGetEnabledProcessors(
    [out]   DWORD * pEnabledProcessors,
);

Parameters

[out] pEnabledProcessors

A pointer to a value that is set to the total number of processors that are enabled on the system.

Note: The value of this parameter is only meaningful after the real-time Subsystem has been started at least once. If the real-time Subsystem has never been started, this parameter's value is 0.

Return Value

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

Remarks

The value that pEnabledProcessors is set to by this function can be smaller than the total number of processors on the machine in the case where the Activation and Configuration Utility was configured to use less processors than the total number on the machine.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib