RtSetTimeQuantum

RtSetTimeQuantum sets the time quantum for the specified thread.

Syntax

BOOL RtSetTimeQuantum(
    HANDLE hThread,
    ULONG64 timeQuantumInMS
);

Parameters

hThread

The handle of the thread whose time quantum will be set.

timeQuantumInMS

The time quantum value in milliseconds, to set for the specified thread. The time quantum is amount of time the thread will run before it yields to another RTSS thread with the same priority.

Return Value

TRUE if the function succeeds, FALSE if the function fails

To get extended 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.

Requirements

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

See Also:

RtGetTimeQuantum