RtGetProcessIdealProcessor

RtGetProcessIdealProcessor retrieves the ideal processor for a given RTSS process handle.

Syntax

Copy
BOOL RtGetProcessIdealProcessor(
    [in]    HANDLE hProcess,
    [out]   PULONG pIdealProcessor,
);

Parameters

[in] hProcess

A handle to the RTSS process that you want to get the ideal processor for.

[out] pIdealProcessor

A pointer to a variable that receives the ideal processor value.

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:

Code Meaning

ERROR_INVALID_HANDLE

The process handle cannot be found.

ERROR_INVALID_PARAMETER

The specified parameter is invalid.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtApi.h

RtApi.lib (Windows), Startup.lib (RTSS)

See Also: