RtGetThreadPriority

NOTE: For Windows applications linked with RTX64, RtGetThreadPriority has been deprecated and will be removed from RTAPI in a future release. For compatibility, a new call RtGetProxyThreadPriority has been defined. IntervalZero recommends that all references to RtGetThreadPriority in a Windows application be replaced with RtGetProxyThreadPriority if you want to control how a thread interacts with the Real-time Subsystem.

RtGetThreadPriority returns the priority value for the specified thread.

In an RTSS environment, RTSS has no distinct priority classes and the priority value specified is the only determination of a thread's priority.

Syntax

INT RtGetThreadPriority(
    HANDLE hThread
);

Parameters

hThread

The thread identifier.

Return Value

The thread priority level if the function succeeds, the THREAD_PRIORITY_ERROR_RETURN if the function fails

To get extended error information, call GetLastError.

Remarks

For more information on the scheduling environment, read the section on Thread Priorities.

NOTE: We recommend you do not use RtGetThreadPriority in the Windows environment.

Requirements

Minimum Supported Version RTX64 2013
Header Rtapi.h
Library RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)

See Also:

RtSetThreadPriority