blob: 86edbd8bcaa79c0813849358a2eed8606330b2f2 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies an extension set by the object name.
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/name:/name} ${.:/params[0]/name}
- ${../../type/if/id:/name} *${.:/params[1]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive obtains an extension set identifier associated with the
extension set name specified in ${.:/params[0]/name}.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-ctx-devinit
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_extension_ident
notes: |
If the extension set name is not unique, then the extension set identifier
will match the first extension set with that name in the search order.
However, this extension set identifier is not guaranteed to correspond to the
desired extension set.
The objects are searched from lowest to the highest index. Only the local
node is searched.
The extension set identifier is used with other extension related directives
to access the extension set.
params:
- description: |
is the object name to look up.
dir: null
name: name
- description: |
is the pointer to an ${../../type/if/id:/name} object. When the directive
call is successful, the object identifier of an object with the specified
name will be stored in this object.
dir: out
name: id
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: |
The ${.:/params[0]/name} parameter was 0.
value: ${../../status/if/invalid-name:/name}
- description: |
There was no object with the specified name on the local node.
value: ${../../status/if/invalid-name:/name}
type: interface
|
