www.beck-ipc.com

@CHIP-RTOS C Library - RTOS API


RTX_Timer_Delay

Set timer delay interval in milliseconds.

int RTX_Timer_Delay ( unsigned int timerID
                     long delay_ms);

Parameters

timerID

The timer ID output from RTX_Install_Timer.

delay_ms

Delay period in milliseconds.   If this value is zero the timer is deactivated.

Return Value

0 on success else error code.

Comments

This function can be used on periodic timers to set the interval to the next call, thereby providing a phase control.

For non-periodic timers this function can be called with varying delay values.

When 'delay_ms' is set to '1', this function is identical to the RTX_Start_Timer function (assuming 1 kHz RTI operation).

When 'delay_ms' is set to '0', this function is identical to the RTX_Stop_Timer function.

See Also

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Related Topics

RTX API   Overview

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3SC2x
    V1.20V1.20V1.20V1.05V1.00

Supported by @CHIP-RTOS C Library since version

    CLIB
    V2.04

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document