diff options
Diffstat (limited to 'c-user/timer/directives.rst')
| -rw-r--r-- | c-user/timer/directives.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/c-user/timer/directives.rst b/c-user/timer/directives.rst index b5ec8f4..2237b30 100644 --- a/c-user/timer/directives.rst +++ b/c-user/timer/directives.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) .. This file is part of the RTEMS quality process and was automatically @@ -55,9 +55,9 @@ Creates a timer. This parameter is the object name of the timer. ``id`` - This parameter is the pointer to an object identifier variable. When the - directive call is successful, the identifier of the created timer will be - stored in this variable. + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the identifier of the created timer will + be stored in this object. .. rubric:: DESCRIPTION: @@ -137,9 +137,9 @@ Identifies a timer by the object name. This parameter is the object name to look up. ``id`` - This parameter is the pointer to an object identifier variable. When the - directive call is successful, the object identifier of an object with the - specified name will be stored in this variable. + This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When + the directive call is successful, the object identifier of an object with + the specified name will be stored in this object. .. rubric:: DESCRIPTION: @@ -212,8 +212,9 @@ Cancels the timer. This directive cancels the timer specified by ``id``. This timer will be reinitiated by the next invocation of :ref:`InterfaceRtemsTimerReset`, -:ref:`InterfaceRtemsTimerFireAfter`, or :ref:`InterfaceRtemsTimerFireWhen` with -the same timer identifier. +:ref:`InterfaceRtemsTimerFireAfter`, :ref:`InterfaceRtemsTimerFireWhen`, +:ref:`InterfaceRtemsTimerServerFireAfter`, or +:ref:`InterfaceRtemsTimerServerFireWhen` with the same timer identifier. .. rubric:: RETURN VALUES: @@ -395,7 +396,7 @@ Fires the timer at the time of day. rtems_status_code rtems_timer_fire_when( rtems_id id, - rtems_time_of_day *wall_time, + const rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data ); @@ -648,7 +649,7 @@ Fires the timer at the time of day using the Timer Server. rtems_status_code rtems_timer_server_fire_when( rtems_id id, - rtems_time_of_day *wall_time, + const rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data ); @@ -810,9 +811,9 @@ Gets information about the timer. This parameter is the timer identifier. ``the_info`` - This parameter is the pointer to a timer information variable. When the - directive call is successful, the information about the timer will be - stored in this variable. + This parameter is the pointer to an :ref:`InterfaceRtemsTimerInformation` + object. When the directive call is successful, the information about the + timer will be stored in this object. .. rubric:: DESCRIPTION: |