RtGetTimeQuantum

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

Syntax

BOOL RtGetTimeQuantum(
    [in]    HANDLE hThread,
    [out]   ULONG64 timeQuantumInMs        
);

Parameters

[in] hThread

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

[out] 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. Call GetLastError to obtain an error code.

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 wRTOS 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

See Also:

• RtSetTimeQuantum