blob: de9592bca5c65ad17a5ea1c09aac31e608ae86fb (
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the object name associated with the object identifier as a string.
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}
- ${/c/if/size_t:/name} ${.:/params[1]/name}
- char *${.:/params[2]/name}
return: char *
variants: []
description: |
The object name is stored in the name buffer. If the name buffer length is
greater than zero, then the stored object name will be ``NUL`` terminated.
The stored object name may be truncated to fit the length. There is no
indication if a truncation occurred. Every attempt is made to return name as
a printable string even if the object has the Classic API 32-bit integer
style name.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_object_get_name
notes:
This directive may cause the calling task to be preempted due to an obtain
and release of the object allocator mutex.
params:
- description: |
is the object identifier to get the name.
dir: null
name: id
- description: |
is the buffer length in bytes.
dir: null
name: length
- description: |
is the pointer to a buffer of the specified length.
dir: out
name: name
return:
return: |
Returns the ``${.:/params[2]/name}`` parameter value, if there is an object
name associated with the object identifier.
return-values:
- description: |
The ${.:/params[1]/name} parameter was 0.
value: ${/c/if/null:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${/c/if/null:/name}
- description: |
There was no object information available for the object identifier.
value: ${/c/if/null:/name}
- description: |
There was no object associated with the object identifier.
value: ${/c/if/null:/name}
type: interface
|
