RtGetProcessorInfo

RtGetProcessorInfo retrieves the system-wide processor numbers for the lowest and highest RTSS processors.

Syntax

BOOL RtGetProcessorInfo(
    PDWORD lpLowestSystemProcessor,
    PDWORD lpHighestSystemProcessor
);

Parameters

lpLowestSystemProcessor

A pointer to a DWORD whose value will be changed to the lowest RTSS processor upon a success.

lpHighestSystemProcessor

A pointer to a DWORD whose value will be changed to the highest RTSS processor upon a success.

Return Value

Returns true if the function succeeds. Returns false if the function fails.

To get extended error information, call GetLastError.

Remarks

If either parameter is NULL, this function returns ERROR_INVALID_PARAMETER.

Processors are identified by their 0-based system-wide processor number when using an affinity mask within an RTAPI call.

For example, three processors are dedicated to Windows and five are dedicated to RTSS. Physically, this configuration translates into dedicating Processors 0, 1, and 2 to Windows and Processors 3 through 7 to RTSS.

Requirements

Minimum Supported Version

RTX64 3.4

API changes for RTX64 4.0

  • Changed PDWORD_PTR lpLowestSystemProcessor to PDWORD lpLowestSystemProcessor
  • Changed PDWORD_PTR lpHighestSystemProcessor to PDWORD lpHighestSystemProcessor
Header Rtapi.h
Library RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)

See Also:

RtSetProcessAffinityMask

RtGetProcessAffinityMask