libexplain/buffer/errno/getsockopt.h File Reference

#include <libexplain/ac/sys/socket.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_getsockopt (explain_string_buffer_t *sb, int errnum, int fildes, int level, int name, void *data, socklen_t *data_size)

---

Function Documentation

void explain_buffer_errno_getsockopt	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		int	level,
		int	name,
		void *	data,
		socklen_t *	data_size
	)

The explain_buffer_errno_getsockopt function is used to obtain an explanation of an error returned by the getsockopt(2) 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 safe 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.
fildes	The original fildes, exactly as passed to the getsockopt(2) system call.
level	The original level, exactly as passed to the getsockopt(2) system call.
name	The original name, exactly as passed to the getsockopt(2) system call.
data	The original data, exactly as passed to the getsockopt(2) system call.
data_size	The original data_size, exactly as passed to the getsockopt(2) system call.

Definition at line 110 of file getsockopt.c.