summaryrefslogtreecommitdiffstats
path: root/spec/rtems/object/if/api-minimum-class.yml
blob: 032e96779a68ca7a99de6602f8ccbce4571c6992 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the lowest valid class value of the object API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2009 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: null
    params:
    - int ${.:/params[0]/name}
    return: int
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_object_api_minimum_class
notes: null
params:
- description: |
    is the object API to get the lowest valid class value.
  dir: null
  name: api
return:
  return: |
    Returns the lowest valid class value of the object API.
  return-values:
  - description: |
      The object API was invalid.
    value: -1
type: interface