blob: a582c3375278798e09eff6f9367fcddd3adcedb1 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Cancels the timer.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive cancels the timer specified in the ${.:/params[0]/name}
parameter. This timer will be reinitiated by the next invocation of
${reset:/name}, ${fire-after:/name}, or ${fire-when:/name} with the same
timer identifier.
enabled-by: true
index-entries:
- cancel a timer
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_timer_cancel
notes: |
This directive will not cause the running task to be preempted.
params:
- description: is the timer identifier.
dir: null
name: id
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
There was no timer associated with the identifier specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
type: interface
|
