path: root/spec/rtems/object/if/get-api-name.yml

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets a descriptive name 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}
    return: const char *
  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_get_api_name
notes: |
  The string returned is from constant space.  Do not modify or free it.
params:
- description: |
    is the object API to get the name.
  dir: null
  name: api
return:
  return: |
    Returns a descriptive name of the API, if the API was valid.
  return-values:
  - description: |
      The API was invalid.
    value: '"BAD API"'
type: interface