RtfwGetDefaultIdealProcessor

The RtfwGetDefaultIdealProcessor function retrieves the default core where the subsystem will run a process' main thread unless an ideal processor is provided when running the process.

Syntax

bool RtfwGetDefaultIdealProcessor(
    [out] DWORD* pDefaultIdealProcessor
);

Parameters

[out] pDefaultIdealProcessor

A pointer to a DWORD variable that receives the identifier of the default ideal processor.

Return Value

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

Remarks

• A return value of 0xFFFFFFFF for pDefaultIdealProcessor indicates that the first core assigned to the subsystem is the default processor.

• A pDefaultIdealProcessor value that is lower than or equal to the first configured RTSS core indicates that the default ideal processor is the first available RTSS core.

Note: A pDefaultIdealProcessor value lower than the first core or higher than the total number of available cores can only occur if the user manually modifies the system configuration, such as by enabling or disabling hyper-threading.

Requirements

See Also: