RtSetThreadTimeQuantum

RtSetThreadTimeQuantum sets the time quantum for the specified thread.

Syntax

BOOL RtSetThreadTimeQuantum(
    HANDLE hThread,
    DWORD dwQuantumInMS
);

Parameters

hThread

The handle of the thread whose time quantum is to be set.

dwQuantumInMS

A new time quantum value in milliseconds. The amount of time the thread will run before it yields to another RTSS thread with the same priority.

Return Values

TRUE if the function succeeds, FALSE if the function fails

To get extended information, call GetLastError.

Remarks

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

In an 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 RTX Properties control panel. Click the System tab and in the Behavior section of the window, click Settings.

Requirements

Header	Rtapi.h
Library	Rtx_Rtss.lib