summaryrefslogtreecommitdiffstats
path: root/spec/rtems/support/if/is-name-valid.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/support/if/is-name-valid.yml')
-rw-r--r--spec/rtems/support/if/is-name-valid.yml36
1 files changed, 36 insertions, 0 deletions
diff --git a/spec/rtems/support/if/is-name-valid.yml b/spec/rtems/support/if/is-name-valid.yml
new file mode 100644
index 00000000..55cc5b55
--- /dev/null
+++ b/spec/rtems/support/if/is-name-valid.yml
@@ -0,0 +1,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/if/code:/name} ${.:/params[0]/name}
+ return: ${/c/if/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