blob: 8467e96b113ab5b6cd1e0ddcdf1e955d27e501e2 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the object class information of the object class of the object API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- int ${.:/params[0]/name}
- int ${.:/params[1]/name}
- ${api-class-information:/name} *${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_object_get_class_information
notes: |
This directive is strictly local and does not impact task scheduling.
params:
- description: |
is the object API of the object class.
dir: null
name: the_api
- description: |
is the object class of the object API to get the class information.
dir: null
name: the_class
- description: |
is the pointer to an object class information variable. The object class
information of the class of the API will be stored in this variable, in
case of a successful operation.
dir: null
name: info
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
The class of the API or the API was invalid.
value: ${../../status/if/invalid-number:/name}
type: interface
|