libexplain/getrlimit_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/resource.h>
#include <libexplain/getrlimit.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_getrlimit_on_error (int resource, struct rlimit *rlim)

---

Function Documentation

int explain_getrlimit_on_error	(	int	resource,
		struct rlimit *	rlim
	)

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

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

 if (explain_getrlimit_on_error(resource, rlim) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

resource	The resource, exactly as to be passed to the getrlimit(2) system call.
rlim	The rlim, exactly as to be passed to the getrlimit(2) system call.

Returns:

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

Definition at line 27 of file getrlimit_on_error.c.