RtfwGetRtssProcessorsActual
RtfwGetRtssProcessorsActual returns the actual number of processors being used by the Real-time Subsystem.
Syntax
bool RtfwGetRtssProcessorsActual( DWORD * pRtssProcessorsActual, );
Parameters
pRtssProcessorsActual
A pointer to a value that is set to the actual number of RTX64 processors being used by the Real-time Subsystem.
Return Value
The function returns true with a value if it succeeds. Otherwise, it returns false and sets the last error value. Call GetLastError for additional error information.
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 RTX64 through the Activation and Configuration Utility |
Stopped | The number of processors assigned to RTX64 through the Activation and Configuration Utility |
Started | The number of processors assigned to RTX64 through the Activation and Configuration Utility |
Requirements
Minimum Required Version | RTX64 4.4 |
Header | RtfwAPI.h |
Library | RtfwAPI.lib |
See Also: