blob: 88c0cf848f747be77b914616229c9ed665b46460 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets a descriptive name of the object API.
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:
- int ${.:/params[0]/name}
return: const char *
variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_object_get_api_name
notes: |
This directive is strictly local and does not impact task scheduling.
The string returned is from constant space. Do not modify or free it.
params:
- description: |
is the object API to get the name.
dir: null
name: api
return:
return: |
Returns a descriptive name of the API, if the API was valid.
return-values:
- description: |
The API was invalid.
value: '"BAD API"'
type: interface
|