summaryrefslogtreecommitdiffstats
path: root/spec/rtems/object/if/api-class-information.yml
blob: 17da71e331bfe34e417f3c0ad5d6491b3ac40da6 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
 This structure is used to return information to the application about the
 objects configured for a specific API/Class combination.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default:
    brief: |
      This member contains the minimum valid object identifier for this class.
    definition: ${../../type/if/id:/name} ${.:name}
    description: null
    kind: member
    name: minimum_id
  variants: []
- default:
    brief: |
      This member contains the maximum valid object identifier for this class.
    definition: ${../../type/if/id:/name} ${.:name}
    description: null
    kind: member
    name: maximum_id
  variants: []
- default:
    brief: |
      This member contains the maximum number of active objects configured
      for this class.
    definition: ${/c/if/uint32_t:/name} ${.:name}
    description: null
    kind: member
    name: maximum
  variants: []
- default:
    brief: |
      This member is true, if this class is configured for automatic object
      extension, otherwise it is false.
    definition: ${/c/if/bool:/name} ${.:name}
    description: null
    kind: member
    name: auto_extend
  variants: []
- default:
    brief: |
      This member contains the number of currently inactive objects of this
      class.
    definition: ${/c/if/uint32_t:/name} ${.:name}
    description: null
    kind: member
    name: unallocated
  variants: []
definition-kind: typedef-only
description: null
enabled-by: true
index-entries: []
interface-type: struct
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: rtems_object_api_class_information
notes: null
type: interface