strerror

Name

perror, strerror, strerror_r, sys_errlist, sys_nerr
- system error messages

Library

libc.lib

Synopsis

#include <stdio.h>

void perror (const char *string);
extern const char * const sys_errlist[] ; extern const int sys_nerr ;

#include <string.h>

char * strerror (int errnum);

int strerror_r (int errnum, char *strerrbuf, size_t buflen);

Return values

strerror function returns the appropriate error description string, or an unknown error message if the error code is unknown. The value of errno is not changed for a successful call, and is set to a nonzero value upon error. The strerror_r function returns 0 on success and -1 on failure, setting errno.

Detailed description

The strerror, strerror_r and perror functions look up the error message string corresponding to an error number.

The strerror function accepts an error number argument errnum and returns a pointer to the corresponding message string.

The strerror_r function renders the same result into strerrbuf for a maximum of buflen characters and returns 0 upon success.

The perror function finds the error message corresponding to the current value of the global variable errno and writes it, followed by a newline, to the standard error file descriptor. If the argument string is non- NULL and does not point to the null character, this string is prepended to the message string and separated from it by a colon and space (": "); otherwise, only the error message string is printed.

If the error number is not recognized, these functions return an error message string containing "Unknown error: " followed by the error number in decimal. The strerror and strerror_r functions return EINVAL as a warning. Error numbers recognized by this implementation fall in the range 0 < errnum < sys_nerr.

If insufficient storage is provided in strerrbuf (as specified in buflen) to contain the error string, strerror_r returns ERANGE and strerrbuf will contain an error message that has been truncated and NUL terminated to fit the length specified by buflen.

The message strings can be accessed directly using the external array sys_errlist. The external value sys_nerr contains a count of the messages in sys_errlist. The use of these variables is deprecated; strerror or strerror_r should be used instead.

Examples

#include <string.h>
#include <stdio.h>
#include <errno.h>
int main()
{
    char *ptr = strerror(ERANGE);
    printf("strerror(ERANGE) = %s\n",ptr);
    return 0;
}

Output

strerror(ERANGE) = Numerical result out of range

Bugs

For unknown error numbers, the strerror function will return its result in a static buffer which may be overwritten by subsequent calls.

The return type for strerror is missing a type-qualifier; it should actually be const char * .

Programs that use the deprecated sys_errlist variable often fail to compile because they declare it inconsistently.

Feedback

For additional information or queries on this page send feedback