Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
STRERROR(3)	       FreeBSD Library Functions Manual		   STRERROR(3)

NAME
     perror, strerror, strerror_r, sys_errlist,	sys_nerr -- system error mes-
     sages

LIBRARY
     Standard C	Library	(libc, -lc)

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);

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	cur-
     rent value	of the global variable errno (intro(2))	and writes it, fol-
     lowed by a	newline, to the	standard error file descriptor.	 If the	argu-
     ment 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	errnum is not a	recognized error number, strerror() returns an error
     message string containing ``Unknown error:	'' followed by the error num-
     ber in decimal and	sets errno to EINVAL.  strerror_r() leaves strerrbuf
     unchanged and returns EINVAL.  Error numbers recognized by	this implemen-
     tation 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 mes-
     sages in sys_errlist.  The	use of these variables is deprecated;
     strerror()	or strerror_r()	should be used instead.

SEE ALSO
     intro(2), psignal(3)

HISTORY
     The strerror() and	perror() functions first appeared in 4.4BSD.  The
     strerror_r() function was implemented in FreeBSD 4.4 by Wes Peters
     <wes@freebsd.org>.

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

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

FreeBSD	11.1			 Nov 26, 2001			  FreeBSD 11.1

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY | BUGS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=strerror&sektion=3&manpath=FreeBSD+4.7-RELEASE>

home | help