RtGetDefaultIdealProcessorNumber

RtGetDefaultIdealProcessorNumber returns the default ideal processor number that will be assigned to any RTSS process that is not assigned a specific process affinity mask or ideal processor.

Syntax

BOOL RtGetDefaultIdealProcessorNumber
    [out]   ULONG  *ProcessorNumber
);

Parameters

[out] ProcessorNumber

A pointer to an unsigned long that will be set to the default ideal processor number used by the Subsystem.

Return Value

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

Possible error codes:

Remarks

The value returned by RtGetDefaultIdealProcessorNumber can differ from the default ideal processor set in wRTOS Settings or returned by the Managed and Configuration and Control (RTFW) libraries. This will occur when the default ideal processor is changed without restarting the Subsystem.