RtGetCurrentHalTimerPeriod

RtGetCurrentHalTimerPeriod returns the current HAL timer period value used by the Subsystem.

Syntax

BOOL RtGetCurrentHalTimerPeriod
    unsigned int * pHalTimerPeriod
);

Parameters

pHalTimerPeriod

A pointer to an unsigned int that will be set to the current HAL timer period (in microseconds) used by the Subsystem.

Return Value

Returns TRUE if the function succeeds, FALSE if the function fails. To get extended error information, call GetLastError.

Error Codes

Error	Meaning
ERROR_INVALID_PARAMETER	The pointer is NULL.

Remarks

The value returned by RtGetCurrentHalTimerPeriod can differ from the HAL timer value in the Control Panel or returned by the Managed and Native frameworks. This will occur when the HAL timer period is changed without restarting the Subsystem.