libexplain/buffer/errno/getrusage.h File Reference

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

Go to the source code of this file.

Functions
void	explain_buffer_errno_getrusage (explain_string_buffer_t *sb, int errnum, int who, struct rusage *usage)
void	explain_buffer_errno_getrusage_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int who, struct rusage *usage)

---

Function Documentation

void explain_buffer_errno_getrusage	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	who,
		struct rusage *	usage
	)

The explain_buffer_errno_getrusage function is used to obtain an explanation of an error returned by the getrusage(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 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.
who	The original who, exactly as passed to the getrusage(2) system call.
usage	The original usage, exactly as passed to the getrusage(2) system call.

Definition at line 76 of file getrusage.c.

void explain_buffer_errno_getrusage_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	who,
		struct rusage *	usage
	)

The explain_buffer_errno_getrusage_explanation function is used to obtain the explanation (the part after "because") of an error returned by the getrusage(2) system call (and similar).

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.
syscall_name	The name of the offending system call.
who	The original who, exactly as passed to the getrusage(2) system call.
usage	The original usage, exactly as passed to the getrusage(2) system call.

Definition at line 45 of file getrusage.c.