blob: 04072e66d9e728a51dd6eaa983ef49e159c71737 (
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
67
68
69
70
71
72
73
74
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Sets the object name of the object associated with the object identifier.
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}
- const char *${.:/params[1]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive will set the object name based upon the user string.
enabled-by: true
index-entries: []
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-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/object-allocator
name: rtems_object_set_name
notes: |
This directive can be used to set the name of objects which do not have a
naming scheme per their API.
If the object specified by ${.:/params[0]/name} is of a class that has a
string name, this directive will free the existing name to the RTEMS Workspace
and allocate enough memory from the RTEMS Workspace to make a copy of the
string located at ${.:/params[1]/name}.
If the object specified by ${.:/params[0]/name} is of a class that has a
32-bit integer style name, then the first four characters in
${.:/params[1]/name} will be used to construct the name.
params:
- description: |
is the object identifier of the object to set the name.
dir: null
name: id
- description: |
is the object name to set.
dir: null
name: name
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
There was no object information available for the object identifier.
value: ${../../status/if/invalid-id:/name}
- description: |
There was no object associated with the object identifier.
value: ${../../status/if/invalid-id:/name}
- description: |
There was no memory available to duplicate the name.
value: ${../../status/if/no-memory:/name}
type: interface
|
