SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Cancels the period.
copyrights:
- Copyright (C) 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 cancels the rate monotonic period specified by
  ${.:/params[0]/name}.  This period may be reinitiated by the next invocation
  of ${period:/name}.
enabled-by: true
index-entries:
- cancel a period
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: /constraint/directive-no-preempt
- role: constraint
  uid: /constraint/directive-creator-only
name: rtems_rate_monotonic_cancel
notes: null
params:
- description: |
    is the rate monotonic period 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 rate monotonic period associated with the identifier
      specified by ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
  - description: |
      The rate monotonic period was not created by the calling task.
    value: ${../../status/if/not-owner-of-resource:/name}
type: interface