|C standard library|
errno.h is a header file in the standard library of the C programming language. It defines macros for reporting and retrieving error conditions through error codes stored in a static memory location called
errno (short for "error number").
A value (the error number) is stored in
errno by certain library functions when they detect errors. At program startup, the value stored is zero. Library functions store only values greater than zero. Any library function can alter the value stored before return, whether or not they detect errors. Most functions indicate that they detected an error by returning a special value, typically NULL for functions that return pointers, and −1 for functions that return integers. A few functions require the caller to preset
errno to zero and test it afterwards to see if an error was detected.
errno macro expands to an lvalue with type
int, sometimes with the
volatile type specifiers depending upon the platform, containing the last error code generated in any function using the errno facility. Originally this was a static memory location, but macros are almost always used today to allow for multi-threading, such that each thread will see its own error number.
The header file also defines macros that expand to integer constants that represent the error codes. The C standard library only requires three to be defined:
- Results from a parameter outside a function's domain, e.g.
- Results from a result outside a function's range, e.g.
strtol("0xfffffffff",NULL,0)on systems with a 32-bit wide
EILSEQ (Required since 1994 Amendment 1 to C89 standard)
- Results from an illegal byte sequence, e.g.
mbstowcs(buf,"\xff", 1)on systems that use UTF-8.
POSIX compliant operating systems like AIX, Linux or Solaris include many other error values, many of which are used much more often than the above ones, such as EACCES for when a file cannot be opened for reading. C++11 additionally defines many of the same values found within the POSIX specification.
- International Standard for Programming Language C (C99), ISO/IEC 9899:1999, p. 186
- "Checking for Errors". The GNU C Library (glibc). GNU Project. 2014-02-08. Retrieved 2014-06-25.
- "A brief description of Normative Addendum 1". Retrieved 2013-09-12.
- The Single UNIX® Specification, Issue 7 from The Open Group: system error numbers – Base Definitions Reference,
- "Error numbers - cppreference.com". Retrieved 2015-05-08.
- Stevens & Rago 2013, p. 14.
- W. Richard, Stevens; Stephen A., Rago (May 24, 2013). Advanced Programming in the UNIX Environment (Third ed.). Addison-Wesley Professional. ISBN 978-0321637734. Retrieved 27 February 2015.