SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Deletes the partition.
copyrights:
- Copyright (C) 2020, 2021 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:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive deletes the partition specified by ${.:/params[0]/name}.
enabled-by: true
index-entries:
- delete a partition
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-ctx-devinit
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: /constraint/object-allocator
- role: constraint
  uid: /constraint/mp-send
- role: constraint
  uid: ../../constraint/delete-by-any-task
- role: constraint
  uid: /constraint/obj-unlimited-free
name: rtems_partition_delete
notes: |
  The partition cannot be deleted if any of its buffers are still allocated.

  The ${/glossary/ptcb:/term} for the deleted partition is reclaimed by RTEMS.

  When a global partition is deleted, the partition identifier must be
  transmitted to every node in the system for deletion from the local copy of
  the global object table.

  The partition must reside on the local node, even if the partition was
  created with the ${../../attr/if/global:/name} attribute.
params:
- description: |
    is the partition identifier.
  dir: null
  name: id
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      There was no partition associated with the identifier specified by
      ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
  - description: |
      The partition resided on a remote node.
    value: ${../../status/if/illegal-on-remote-object:/name}
  - description: |
      There were buffers of the partition still in use.
    value: ${../../status/if/resource-in-use:/name}
type: interface