RtGetThreadTimeQuantum

RtGetThreadTimeQuantum gets the current time quantum, in milliseconds, for the specified thread.

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

Syntax

DWORD RtGetThreadTimeQuantum(
    HANDLE hThread
);

Paramenters

hThread

The handle for the specified thread, in milliseconds.

Return Value

The thread's time quantum in milliseconds if the function succeeds, 0 (zero) if the function fails

To get extended error information, call GetLastError.

Remarks

In the Win32 environment, the only valid time quantum value is 0. This time quantum simulates Windows scheduling policy.

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.

Requirements

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

See Also:

RtSetThreadTimeQuantum