Subsystem.SetHALTimerPeriod Method

This method sets the HAL timer period, in microseconds, for the wRTOS Subsystem. It returns False if it fails, True if it succeeds.

Certain Subsystem properties, such as TCP/IP Stack Tick Interval, Watchdog Timer, and Default Time Quantum, must always be multiples of the HAL Timer. When the HALTimerPeriod is changed, these other properties may change automatically to satisfy this requirement. When this occurs, the SetHALTimerPeriod method sets a warning to a non-zero error code.

Namespace: IntervalZero.MaxRT.wRTOS.Config
Assembly: IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy

public void SetHALTimerPeriod(
    uint newHALTimerPeriod,
    out wRTOSErrorCode warning
)

Parameters

newHALTimerPeriod

Type: uint
The HAL timer period, in microseconds. This value must be within the range 1 to 1000.

warning

Type: IntervalZero.MaxRT.wRTOS.Config.wRTOSErrorCode

Implements

IConfigSubsystem.SetHALTimerPeriod