blob: 3647b311eafb0b488dc97cd5f0299d6cc6db3eb8 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Maps the status code to a descriptive text.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
attributes: null
body: null
params:
- ${code:/name} ${.:/params[0]/name}
return: const char *
variants: []
description: |
The text for each status code is the enumerator constant.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_status_text
notes: null
params:
- description: is the status code.
dir: null
name: status_code
return:
return: |
Returns a text describing the status code, if the status code is valid.
return-values:
- description: The status code is invalid.
value: '"?"'
type: interface
|
