blob: aacb1bcb9d5acce44bdc5126f31c85536217e060 (
plain) (
tree)
|
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets information about the RTEMS Workspace.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${/score/heap/if/information-block:/name} *${.:/params[0]/name}
return: ${/c/if/bool:/name}
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-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/object-allocator
name: rtems_workspace_get_information
notes: null
params:
- description: |
is the pointer to a ${/score/heap/if/information-block:/name} object. When
the directive call is successful, the heap information will be stored in
this object.
dir: out
name: the_info
return:
return: |
Returns true, if getting the information was successful, otherwise false.
return-values: []
type: interface
|