blob: 60b67db3c06ff0862bbda130e28d47bca53f7d6c (
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: |
Gets the maximum task priority of the scheduler instance.
copyrights:
- Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
body: null
params:
- ${../types/id:/name} ${.:/params[0]/name}
- ${../tasks/priority:/name} *${.:/params[1]/name}
return: ${../status/code:/name}
variants: []
description: null
enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: ../tasks/header
- role: interface-ingroup
uid: ../tasks/group
name: rtems_scheduler_get_maximum_priority
notes: null
params:
- description: is the scheduler instance identifier.
dir: null
name: scheduler_id
- description: |
is the pointer to a task priority variable. The maximum priority of the
scheduler instance will be stored in this variable, if the operation is
successful.
dir: out
name: priority
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../status/successful:/name}
- description: |
The ${.:/params[1]/name} parameter was ${/if/c/null:/name}.
value: ${../status/invalid-address:/name}
- description: |
The scheduler instance identifier was invalid.
value: ${../status/invalid-id:/name}
type: interface
|
