summaryrefslogtreecommitdiffstats
path: root/spec/rtems/status/if/is-successful.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/status/if/is-successful.yml')
-rw-r--r--spec/rtems/status/if/is-successful.yml33
1 files changed, 33 insertions, 0 deletions
diff --git a/spec/rtems/status/if/is-successful.yml b/spec/rtems/status/if/is-successful.yml
new file mode 100644
index 00000000..71dce793
--- /dev/null
+++ b/spec/rtems/status/if/is-successful.yml
@@ -0,0 +1,33 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the status code is ${successful:/name}, 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} == ${successful:/name};
+ params:
+ - ${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_status_successful
+notes: null
+params:
+- description: is the status code.
+ dir: null
+ name: status_code
+return:
+ return: null
+ return-values: []
+type: interface