RtfwGetRtssProcessorsActual

RtfwGetRtssProcessorsActual returns the actual number of processors being used by the real-time Subsystem.

Syntax

Copy

bool RtfwGetRtssProcessorsActual(
    [out]    DWORD * pRtssProcessorsActual,
);

Parameters

[out] pRtssProcessorsActual

A pointer to a value that is set to the actual number of wRTOS processors being used by the real-time Subsystem.

Return Value

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

Possible error codes:

Error code	Meaning
ERROR_INVALID_PARAMETER	A null pointer was sent for parameter pRtssProcessorsActual.
RTFW_COMPONENT_STATUS_NOT_CONFIGURED	The Subsystem is not configured.

RtfwGetRtssProcessorsActual returns a different value depending on the state of the Subsystem when the function is called:

Subsystem status	Value
Not configured	0.
Never started	The number of processors assigned to wRTOS through the Activation and Configuration Utility.
Stopped	The number of processors assigned to wRTOS through the Activation and Configuration Utility.
Started	The number of processors assigned to wRTOS through the Activation and Configuration Utility.

Requirements

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