RtGetTimeQuantum

RtGetTimeQuantum retrieves the current time quantum, in milliseconds, for a specified thread.

Syntax

BOOL RtGetTimeQuantum(
    HANDLE hThread,
    ULONG64 timeQuantumInMs		
);

Parameters

hThread

The handle of the specified thread whose time quantum you want to retrieve.

timeQuantumInMs

The time quantum value, in milliseconds, of the specified thread.

Return Value

TRUE if the function succeeds, FALSE if the function fails

To get extended error information, call GetLastError.

Remarks

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.

See Also:

RtSetTimeQuantum