1 | SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause |
---|
2 | brief: | |
---|
3 | Gets information about the timer. |
---|
4 | copyrights: |
---|
5 | - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) |
---|
6 | - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) |
---|
7 | definition: |
---|
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: [] |
---|
16 | description: | |
---|
17 | This directive returns information about the timer. |
---|
18 | enabled-by: true |
---|
19 | index-entries: [] |
---|
20 | interface-type: function |
---|
21 | links: |
---|
22 | - role: interface-placement |
---|
23 | uid: header |
---|
24 | - role: interface-ingroup |
---|
25 | uid: group |
---|
26 | - role: constraint |
---|
27 | uid: /constraint/directive-ctx-isr |
---|
28 | - role: constraint |
---|
29 | uid: /constraint/directive-ctx-devinit |
---|
30 | - role: constraint |
---|
31 | uid: /constraint/directive-ctx-task |
---|
32 | - role: constraint |
---|
33 | uid: /constraint/directive-no-preempt |
---|
34 | name: rtems_timer_get_information |
---|
35 | notes: null |
---|
36 | params: |
---|
37 | - description: is the timer identifier. |
---|
38 | dir: null |
---|
39 | name: id |
---|
40 | - description: | |
---|
41 | is the pointer to a timer information variable. The information about the |
---|
42 | timer will be stored in this variable, in case of a successful operation. |
---|
43 | dir: out |
---|
44 | name: the_info |
---|
45 | return: |
---|
46 | return: null |
---|
47 | return-values: |
---|
48 | - description: | |
---|
49 | The requested operation was successful. |
---|
50 | value: ${../../status/if/successful:/name} |
---|
51 | - description: | |
---|
52 | The ${.:/params[1]/name} parameter was ${/c/if/null:/name}. |
---|
53 | value: ${../../status/if/invalid-address:/name} |
---|
54 | - description: | |
---|
55 | There was no timer associated with the identifier specified by |
---|
56 | ${.:/params[0]/name}. |
---|
57 | value: ${../../status/if/invalid-id:/name} |
---|
58 | type: interface |
---|