SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Maps a Classic API task priority to the corresponding POSIX thread priority.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    - ${../../task/if/priority:/name} ${.:/params[1]/name}
    - int *${.:/params[2]/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_map_priority_to_posix
notes: null
params:
- description: is the scheduler instance identifier.
  dir: null
  name: scheduler_id
- description: is the Classic API task priority to map.
  dir: null
  name: priority
- description: |
    is the pointer to a POSIX thread priority variable.  When the directive
    call is successful, the POSIX thread priority value corresponding to the
    specified Classic API task priority value will be stored in this variable.
  dir: out
  name: posix_priority
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The ${.:/params[2]/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}
  - description: |
      The Classic API task priority was invalid.
    value: ${../../status/if/invalid-priority:/name}
type: interface