summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/seterr.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include/rtems/seterr.h')
-rw-r--r--cpukit/include/rtems/seterr.h53
1 files changed, 53 insertions, 0 deletions
diff --git a/cpukit/include/rtems/seterr.h b/cpukit/include/rtems/seterr.h
new file mode 100644
index 0000000000..22fddc824e
--- /dev/null
+++ b/cpukit/include/rtems/seterr.h
@@ -0,0 +1,53 @@
+/**
+ * @file rtems/seterr.h
+ *
+ * @brief Data which Ease the Burden of Consistently Setting Errno
+ *
+ * This file contains macros and definitions which ease the burden
+ * of consistently setting errno and returning -1.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2006.
+ * On-Line Applications Research Corporation (OAR).
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef _RTEMS_SETERR_H
+#define _RTEMS_SETERR_H
+
+/**
+ * @defgroup ScoreSetErr Set Errno
+ *
+ * @ingroup Score
+ *
+ */
+/**@{*/
+
+#include <errno.h>
+
+/**
+ * This is a helper macro which will set the variable errno and return
+ * the specified value to the caller.
+ *
+ * @param[in] _error is the error code
+ * @param[in] _value is the value to return
+ */
+#define rtems_set_errno_and_return_value( _error, _value ) \
+ do { errno = ( _error ); return ( _value ); } while ( 0 )
+
+/**
+ * This is a helper macro which will set the variable errno and return
+ * -1 to the caller. This pattern is common to many POSIX methods.
+ *
+ * @param[in] _error is the error code
+ */
+#define rtems_set_errno_and_return_minus_one( _error ) \
+ rtems_set_errno_and_return_value( _error, -1 )
+
+/**@}*/
+#endif
+/* end of include file */