SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Identifies a port by the object name.
copyrights:
- Copyright (C) 2020 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/name:/name} ${.:/params[0]/name}
    - ${../../type/if/id:/name} *${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive obtains a port identifier associated with the port name
  specified in ${.:/params[0]/name}.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_port_ident
notes: |
  If the port name is not unique, then the port identifier will match the first
  port with that name in the search order.  However, this port identifier is
  not guaranteed to correspond to the desired port.

  The objects are searched from lowest to the highest index.  Only the local
  node is searched.

  The port identifier is used with other dual-ported memory related directives
  to access the port.
params:
- description: |
    is the object name to look up.
  dir: null
  name: name
- description: |
    is the pointer to an ${../../type/if/id:/name} object.  When the directive
    call is successful, the object identifier of an object with the specified
    name will be stored in this object.
  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 ${.:/params[0]/name} parameter was 0.
    value: ${../../status/if/invalid-name:/name}
  - description: |
      There was no object with the specified name on the local node.
    value: ${../../status/if/invalid-name:/name}
type: interface