blob: f1907c4a7bcf668b199750b9a63c412445adc89c (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Returns a descriptive text for the fatal source.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../userext/if/fatal-source:/name} ${.:/params[0]/name}
return: const char *
variants: []
description: null
enabled-by: true
index-entries:
- fatal error
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
- role: constraint
uid: /constraint/directive-ctx-any
name: rtems_fatal_source_text
notes: null
params:
- description: |
is the fatal source.
dir: null
name: fatal_source
return:
return: |
Returns a descriptive text for the fatal source. The text for the fatal
source is the enumerator constant name.
return-values:
- description: |
The ${.:/params[0]/name} parameter value was not a fatal source.
value: '"?"'
type: interface
|
