libexplain/ioctl_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/ioctl.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/ioctl.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_ioctl_on_error (int fildes, int request, void *data)

---

Function Documentation

int explain_ioctl_on_error	(	int	fildes,
		int	request,
		void *	data
	)

The explain_ioctl_on_error function is used to call the ioctl(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_ioctl(3) function.

This function is intended to be used in a fashion similar to the following example:

 if (explain_ioctl_on_error(fildes, request, data) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

fildes	The fildes, exactly as to be passed to the ioctl(2) system call.
request	The request, exactly as to be passed to the ioctl(2) system call.
data	The data, exactly as to be passed to the ioctl(2) system call.

Returns:

The value returned by the wrapped ioctl(2) system call.

Definition at line 28 of file ioctl_on_error.c.