include/rtems/seterr.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSAPISetErrno
0007  *
0008  * @brief This header file defines macros to set ``errno`` and return minus
0009  *   one.
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2006.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _RTEMS_SETERR_H
0039 #define _RTEMS_SETERR_H
0040
0041 #include <errno.h>
0042
0043 /**
0044  * @defgroup RTEMSAPISetErrno Set Error Number Support
0045  *
0046  * @ingroup RTEMSAPI
0047  *
0048  * @{
0049  */
0050
0051 /**
0052  *  This is a helper macro which will set the variable errno and return
0053  *  the specified value to the caller.
0054  *
0055  *  @param[in] _error is the error code
0056  *  @param[in] _value is the value to return
0057  */
0058 #define rtems_set_errno_and_return_value( _error, _value ) \
0059   do { errno = ( _error ); return ( _value ); } while ( 0 )
0060
0061 /**
0062  *  This is a helper macro which will set the variable errno and return
0063  *  -1 to the caller.  This pattern is common to many POSIX methods.
0064  *
0065  *  @param[in] _error is the error code
0066  */
0067 #define rtems_set_errno_and_return_minus_one( _error ) \
0068   rtems_set_errno_and_return_value( _error, -1 )
0069
0070 /**@}*/
0071 #endif
0072 /* end of include file */