SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Identifies a scheduler by the object name.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/name:/name} ${.:/params[0]/name}
    - ${../../type/if/id:/name} *${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive obtains a scheduler identifier associated with the scheduler
  name specified in ${.:/params[0]/name}.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: ../../task/if/header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_scheduler_ident
notes: |
  The scheduler name is determined by the scheduler configuration.

  The scheduler identifier is used with other scheduler related directives to
  access the scheduler.
params:
- description: |
    is the scheduler name to look up.
  dir: null
  name: name
- description: |
    is the pointer to an object identifier variable.  When the directive call
    is successful, the identifier of the scheduler instance will be stored in
    this variable.
  dir: out
  name: id
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: |
      The scheduler name was invalid.
    value: ${../../status/if/invalid-name:/name}
type: interface