RtGetCurrentHalTimerPeriod

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

Syntax

BOOL RtGetCurrentHalTimerPeriod
    [out]   unsigned int * pHalTimerPeriod
);

Parameters

[out] 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

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Error Codes

Remarks

The value returned by RtGetCurrentHalTimerPeriod can differ from the HAL Timer Period set through wRTOS Settings or returned by the Managed and Configuration and Control (RTFW) libraries. This will occur when the HAL timer period is changed without restarting the Subsystem.