source: rtems-central/spec/rtems/userext/if/ident.yml @ d3edaca

Last change on this file since d3edaca was d3edaca, checked in by Sebastian Huber <sebastian.huber@…>, on 10/12/20 at 13:07:38

spec: Add function attributes

  • Property mode set to 100644
File size: 2.1 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Identifies an extension set object by the specified object name.
4copyrights:
5- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default:
9    attributes: null
10    body: null
11    params:
12    - ${../../type/if/name:/name} ${.:/params[0]/name}
13    - ${../../type/if/id:/name} *${.:/params[1]/name}
14    return: ${../../status/if/code:/name}
15  variants: []
16description: |
17  This directive obtains the extension set identifier associated with the
18  extension set name specified in ``${.:/params[0]/name}``.
19enabled-by: true
20index-entries: []
21interface-type: function
22links:
23- role: interface-placement
24  uid: header
25- role: interface-ingroup
26  uid: group
27name: rtems_extension_ident
28notes: |
29  If the extension set name is not unique, then the extension set identifier
30  will match the first extension set with that name in the search order.
31  However, this extension set identifier is not guaranteed to correspond to the
32  desired extension set.  The extension set identifier is used with other
33  extension related directives to access the extension set.
34
35  The objects are searched from lowest to the highest index.  Only the local
36  node is searched.
37params:
38- description: is the object name to look up.
39  dir: null
40  name: name
41- description: |
42    is the pointer to an object identifier variable.  The object identifier of
43    an object with the specified name will be stored in this variable, in case
44    of a successful operation.
45  dir: out
46  name: id
47return:
48  return: null
49  return-values:
50  - description: |
51      The requested operation was successful.
52    value: ${../../status/if/successful:/name}
53  - description: |
54      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
55    value: ${../../status/if/invalid-address:/name}
56  - description: |
57      The ${.:/params[0]/name} parameter was 0.
58    value: ${../../status/if/invalid-name:/name}
59  - description: |
60      There was no object with the specified name on the local node.
61    value: ${../../status/if/invalid-name:/name}
62type: interface
Note: See TracBrowser for help on using the repository browser.