blob: f0816b1878858ec38fefd4f798a80f4d8f66cef4 (
plain) (
tree)
|
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies a scheduler instance by its 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: 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_ident
notes: |
The scheduler name is determined by the scheduler configuration.
params:
- description: is the scheduler name.
dir: null
name: name
- description: |
is the pointer to an object identifier variable. The identifier of the
scheduler instance will be stored in this variable, in case of a successful
operation.
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
|