source: rtems-central/spec/rtems/object/if/id-get-api.yml @ 0500b9a

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the API component of the object identifier.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default: ${/score/object/if/get-api:/name}( ${.:/params[0]/name} )
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: rtems_object_id_get_api
notes: |
  This directive is strictly local and does not impact task scheduling.

  This directive does not validate the object identifier provided in
  ${.:/params[0]/name}.

  A body is also provided.
params:
- description: |
    is the object identifier with the API component to get.
  dir: null
  name: _id
return:
  return: |
    Returns the API component of the object identifier.
  return-values: []
type: interface