summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/support/is-name-valid.yml
blob: b14ceb99b2998a79356f5f484e5353a6507e09d1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns true, if the specified object name is valid, otherwise returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    body: |
      return ${.:/params[0]/name} != 0;
    params:
    - ${../status/code:/name} ${.:/params[0]/name}
    return: ${/if/c/bool:/name}
  variants: []
description: null
enabled-by: true
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: rtems_is_name_valid
notes: null
params:
- description: is the object name to check.
  dir: null
  name: name
return:
  return: null
  return-values:
  - description: The specified object name is valid.
    value: 'true'
  - description: Otherwise.
    value: 'false'
type: interface