Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

is a pointer to a variable that contains an error code returned by this function.

OS_ERR_NONE

if the call was successful.

OS_ERR_OBJ_PTR_NULL

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if p_tmr is a NULL pointer

OS_ERR_TMR_INVALID_DLY

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if specifying an invalid delay in ONE-SHOT mode. In other words, it is not allowed to delay for 0 in ONE-SHOT mode.

OS_ERR_TMR_INVALID_PERIOD

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if specifying an invalid period in PERIODIC mode. It is not allowed to have a 0 period in PERIODIC.

OS_ERR_OPT_INVALID

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if not specifying a valid options.

OS_ERR_TMR_ISR

if OS_CFG_CALLED_FROM_ISR_CHK_EN set to 1 in os_cfg.h: if calling this function from an ISR.

OS_ERR_ILLEGAL_CREATE_RUN_TIME

if OS_SAFETY_CRITICAL_IEC61508 is defined: you called this after calling OSSafetyCriticalStart() and thus you are no longer allowed to create additional kernel objects.

Returned Values

None.

Notes/Warnings

...