summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/if/container-of.yml
blob: 45d1e4d80dac71d0df7ba1e9bc6131a31cc07767 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the container of a member.
copyrights:
- Copyright (C) 2014 embedded brains GmbH & Co. KG
definition:
  default:
    attributes: null
    body: |
      ( (${.:/params[1]/name} *) ( (${/c/if/uintptr_t:/name}) ( ${.:/params[0]/name} ) - ${/c/if/offsetof:/name}( ${.:/params[1]/name}, ${.:/params[2]/name} ) ) )
    params: []
    return: null
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_CONTAINER_OF
notes: null
params:
- description: |
    is the pointer to a member of the container.
  dir: null
  name: _m
- description: |
    is the type of the container.
  dir: null
  name: _type
- description: |
    is the designator name of the container member.
  dir: null
  name: _member_name
return:
  return: |
    Returns the pointer to the container of a member pointer.
  return-values: []
type: interface