RtGetTimeQuantum

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

Syntax

Copy
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

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE.

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 Process thread will run to completion.

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 Header Library

eRTOS 1.0 SDK

RtssApi.h rtkrnl.lib

See Also: