fixed typos and other minor things
This commit is contained in:
@ -11,26 +11,54 @@
|
||||
/**
|
||||
* @brief The declaration of the external variable `obi_errno`.
|
||||
*
|
||||
* `obi_errno` is an equivalent of `errno` for the system level error
|
||||
* but for for error generated by the C layer of the OBITools framework.
|
||||
* `obi_errno` is an equivalent of `errno` for the system level error,
|
||||
* but for errors generated by the C layer of the OBITools framework.
|
||||
*
|
||||
* @todo We have to look for defining this variable as thread specific.
|
||||
* @todo We have to look into defining this variable as thread specific.
|
||||
*/
|
||||
extern int obi_errno;
|
||||
|
||||
|
||||
/**
|
||||
* @brief set the global `obi_errno` variable with
|
||||
* @brief Sets the global `obi_errno` variable with
|
||||
* the specified `err` code
|
||||
*
|
||||
* This function is defined as a macro to reduce the risk
|
||||
* to increase the problem generating the error by calling
|
||||
* of increasing the problem generating the error by calling
|
||||
* a new function.
|
||||
*
|
||||
* @param err the error code as an integer value
|
||||
* @param err The error code as an integer value.
|
||||
*
|
||||
* @since May 2015
|
||||
* @author Eric Coissac (eric.coissac@metabarcoding.org)
|
||||
*/
|
||||
#define obi_set_errno(err) (obi_errno = (err))
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup OBIDMSErrors OBIDMS related error codes
|
||||
*
|
||||
* Error codes set in errno following an error related
|
||||
* to the manipulation of an OBIDMS.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
#define OBIDMS_EXIST_ERROR (1) /**< Trying to create an OBIDMS with a name
|
||||
* that corresponds to an existing OBIDMS
|
||||
*/
|
||||
#define OBIDMS_NOT_EXIST_ERROR (2) /**< Trying to open a non-existing OBIDMS
|
||||
*/
|
||||
#define OBIDMS_LONG_NAME_ERROR (3) /**< The specified OBIDMS name is too long
|
||||
*/
|
||||
#define OBIDMS_MEMORY_ERROR (4) /**< A memory error occurred during allocation
|
||||
*/
|
||||
#define OBIDMS_UNKNOWN_ERROR (5) /**< Undetermined error
|
||||
*/
|
||||
#define OBIDMS_ACCESS_ERROR (6) /**< Permission error trying to access the database
|
||||
*/
|
||||
#define OBIDMS_BAD_ENDIAN_ERROR (7) /**< The opened data structure does not corresponds
|
||||
* to the endianess of the platform.
|
||||
*/
|
||||
/**@}*/
|
||||
|
||||
#endif /* OBIERRNO_H_ */
|
||||
|
Reference in New Issue
Block a user