SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the maximum task priority of the scheduler instance.
copyrights:
- Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    - ${../../type/if/priority:/name} *${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: ../../task/if/header
- role: interface-ingroup
  uid: group
name: rtems_scheduler_get_maximum_priority
notes: null
params:
- description: is the scheduler instance identifier.
  dir: null
  name: scheduler_id
- description: |
    is the pointer to a task priority variable.  The maximum priority of the
    scheduler instance will be stored in this variable, if the operation is
    successful.
  dir: out
  name: priority
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
    value: ${../../status/if/invalid-address:/name}
  - description: |
      There was no scheduler associated with the identifier specified by
      ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
type: interface