source: rtems-central/spec/rtems/timer/if/ident.yml @ 0500b9a

Last change on this file since 0500b9a was 0500b9a, checked in by Sebastian Huber <sebastian.huber@…>, on Dec 1, 2020 at 1:23:41 PM

interface/interfacedoc: Format parameter names

  • Property mode set to 100644
File size: 2.0 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Identifies a timer 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 timer identifier associated with the timer name
18  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_timer_ident
28notes: |
29  If the timer name is not unique, then the timer identifier will match the
30  first timer with that name in the search order.  However, this timer
31  identifier is not guaranteed to correspond to the desired timer.  The timer
32  identifier is used with other timer related directives to access the timer.
33
34  The objects are searched from lowest to the highest index.  Only the local
35  node is searched.
36params:
37- description: is the object name to look up.
38  dir: null
39  name: name
40- description: |
41    is the pointer to an object identifier variable.  The object identifier of
42    an object with the specified name will be stored in this variable, in case
43    of a successful operation.
44  dir: out
45  name: id
46return:
47  return: null
48  return-values:
49  - description: |
50      The requested operation was successful.
51    value: ${../../status/if/successful:/name}
52  - description: |
53      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
54    value: ${../../status/if/invalid-address:/name}
55  - description: |
56      The ${.:/params[0]/name} parameter was 0.
57    value: ${../../status/if/invalid-name:/name}
58  - description: |
59      There was no object with the specified name on the local node.
60    value: ${../../status/if/invalid-name:/name}
61type: interface
Note: See TracBrowser for help on using the repository browser.