libexplain/buffer/errno/strtol.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_strtol (explain_string_buffer_t *sb, int errnum, const char *nptr, char **endptr, int base)

---

Function Documentation

void explain_buffer_errno_strtol	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	nptr,
		char **	endptr,
		int	base
	)

The explain_buffer_errno_strtol function is used to obtain an explanation of an error returned by the strtol(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
nptr	The original nptr, exactly as passed to the strtol(3) system call.
endptr	The original endptr, exactly as passed to the strtol(3) system call.
base	The original base, exactly as passed to the strtol(3) system call.

Definition at line 113 of file strtol.c.