STRERROR
STRERROR
NAMESYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
ATTRIBUTES
VERSIONS
CONFORMING TO
SEE ALSO
COLOPHON
NAME
strerror, strerror_r, strerror_l − return string describing error number
SYNOPSIS
#include <string.h>
char *strerror(int errnum);
int
strerror_r(int errnum, char
*buf, size_t buflen);
/* XSI-compliant */
char
*strerror_r(int errnum, char
*buf, size_t buflen);
/* GNU-specific */
char *strerror_l(int errnum, locale_t locale);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
strerror_r():
The XSI-compliant version is
provided if:
(_POSIX_C_SOURCE >= 200112L ||
_XOPEN_SOURCE >= 600) &&
! _GNU_SOURCE
Otherwise, the GNU-specific version is provided.
DESCRIPTION
The strerror() function returns a pointer to a string that describes the error code passed in the argument errnum, possibly using the LC_MESSAGES part of the current locale to select the appropriate language. (For example, if errnum is EINVAL, the returned description will be "Invalid argument".) This string must not be modified by the application, but may be modified by a subsequent call to strerror() or strerror_l(). No other library function, including perror(3), will modify this string.
strerror_r()
The strerror_r() function is similar to
strerror(), but is thread safe. This function is
available in two versions: an XSI-compliant version
specified in POSIX.1-2001 (available since glibc 2.3.4, but
not POSIX-compliant until glibc 2.13), and a GNU-specific
version (available since glibc 2.0). The XSI-compliant
version is provided with the feature test macros settings
shown in the SYNOPSIS; otherwise the GNU-specific version is
provided. If no feature test macros are explicitly defined,
then (since glibc 2.4) _POSIX_SOURCE is defined by
default with the value 200112L, so that the XSI-compliant
version of strerror_r() is provided by default.
The XSI-compliant strerror_r() is preferred for portable applications. It returns the error string in the user-supplied buffer buf of length buflen.
The GNU-specific strerror_r() returns a pointer to a string containing the error message. This may be either a pointer to a string that the function stores in buf, or a pointer to some (immutable) static string (in which case buf is unused). If the function stores a string in buf, then at most buflen bytes are stored (the string may be truncated if buflen is too small and errnum is unknown). The string always includes a terminating null byte ('\0').
strerror_l()
strerror_l() is like strerror(), but maps
errnum to a locale-dependent error message in the
locale specified by locale. The behavior of
strerror_l() is undefined if locale is the
special locale object LC_GLOBAL_LOCALE or is not a
valid locale object handle.
RETURN VALUE
The strerror(), strerror_l(), and the GNU-specific strerror_r() functions return the appropriate error description string, or an "Unknown error nnn" message if the error number is unknown.
The XSI-compliant strerror_r() function returns 0 on success. On error, a (positive) error number is returned (since glibc 2.13), or −1 is returned and errno is set to indicate the error (glibc versions before 2.13).
POSIX.1-2001 and POSIX.1-2008 require that a successful call to strerror() or strerror_l() shall leave errno unchanged, and note that, since no function return value is reserved to indicate an error, an application that wishes to check for errors should initialize errno to zero before the call, and then check errno after the call.
ERRORS
|
EINVAL |
The value of errnum is not a valid error number. | ||
|
ERANGE |
Insufficient storage was supplied to contain the error description string. |
ATTRIBUTES
Multithreading
(see pthreads(7))
The strerror() function is not thread-safe.
The strerror_r() function is thread-safe.
VERSIONS
The strerror_l() function first appeared in glibc 2.6.
CONFORMING TO
strerror() is specified by POSIX.1-2001, POSIX.1-2008, C89, and C99. strerror_r() is specified by POSIX.1-2001 and POSIX.1-2008.
strerror_l() is specified in POSIX.1-2008.
The GNU-specific strerror_r() function is a nonstandard extension.
POSIX.1-2001 permits strerror() to set errno if the call encounters an error, but does not specify what value should be returned as the function result in the event of an error. On some systems, strerror() returns NULL if the error number is unknown. On other systems, strerror() returns a string something like "Error nnn occurred" and sets errno to EINVAL if the error number is unknown. C99 and POSIX.1-2008 require the return value to be non-NULL.
SEE ALSO
err(3), errno(3), error(3), perror(3), strsignal(3), locale(7)
COLOPHON
This page is part of release 3.69 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man−pages/.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
