summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/req/container-of-0.yml
blob: e0939c399f8425d12387307622c849d820d4fbb3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
SPDX-License-Identifier: CC-BY-SA-4.0
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: function
links:
- role: interface-function
  uid: ../if/container-of
rationale: null
references: []
requirement-type: functional
text: |
  When argument ${../if/container-of:/params[0]/name} points to a
  member field of a structure or union or C++ class,
  and argument ${../if/container-of:/params[1]/name} is the C type of this
  structure or union or C++ class,
  and argument ${../if/container-of:/params[2]/name} is the name of
  this member field,
  the ${../if/container-of:/name} macro shall result in a pointer
  to the start address of the structure or union or C++ class.
type: requirement