source: rtems-central/spec/rtems/timer/if/get-information.yml @ c970d63

Last change on this file since c970d63 was c970d63, checked in by Sebastian Huber <sebastian.huber@…>, on 12/01/20 at 13:57:03

spec: Review Timer Manager API

  • Property mode set to 100644
File size: 1.5 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Gets information about the timer.
4copyrights:
5- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default:
9    attributes: null
10    body: null
11    params:
12    - ${../../type/if/id:/name} ${.:/params[0]/name}
13    - ${information:/name} *${.:/params[1]/name}
14    return: ${../../status/if/code:/name}
15  variants: []
16description: |
17  This directive returns information about the timer.
18enabled-by: true
19index-entries: []
20interface-type: function
21links:
22- role: interface-placement
23  uid: header
24- role: interface-ingroup
25  uid: group
26name: rtems_timer_get_information
27notes: |
28  This directive will not cause the running task to be preempted.
29params:
30- description: is the timer identifier.
31  dir: null
32  name: id
33- description: |
34    is the pointer to a timer information variable.  The information about the
35    timer will be stored in this variable, in case of a successful operation.
36  dir: out
37  name: the_info
38return:
39  return: null
40  return-values:
41  - description: |
42      The requested operation was successful.
43    value: ${../../status/if/successful:/name}
44  - description: |
45      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
46    value: ${../../status/if/invalid-address:/name}
47  - description: |
48      There was no timer associated with the identifier specified by
49      ${.:/params[0]/name}.
50    value: ${../../status/if/invalid-id:/name}
51type: interface
Note: See TracBrowser for help on using the repository browser.