summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/basedefs/container-of.yml
blob: 1d4070f5acc900188b4ae7176043748158a00801 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns the pointer to the container of a specified member pointer.
copyrights:
- Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default: |
    ( (_type *) ( (${/if/c/uintptr_t:/name}) ( _m ) - ${/if/c/offsetof:/name}( _type, _member_name ) ) )
  variants: []
description: null
enabled-by: true
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 specified member pointer.
  return-values: []
type: interface