RtGetThreadTimeQuantumEx

RtGetThreadTimeQuantumEx gets the current time quantum, in microseconds, for the specified thread.

NOTE: This function is deprecated and will be removed from a future release. Use RtGetTimeQuantum.

Syntax

ULONG64 RtGetThreadTimeQuantumEx(
    HANDLE hThread
);

Paramenters

hThread

The handle for the specified thread.

Return Value

The thread's time quantum if the function succeeds, INVALID_QUANTUM (0x0) if the function fails

To get extended error information, call GetLastError.

Remarks

In the RTSS environment, the time quantum can be any value greater than or equal to zero. A value of zero means the RTSS thread will run to completion.

The default time quantum value can be changed in the Control Panel. Click the System tab and in the Behavior section of the window, click Settings.

The returned thread time quantum interval value may not match the set value if the set value is not a multiple of the HAL timer period.

Requirements

Minimum Supported Version RTX64 3.0
Header RtssApi.h
Library Rtx_Rtss.lib

See Also:

RtGetThreadTimeQuantum

RtSetThreadTimeQuantum

RtSetThreadTimeQuantumEx