libexplain/message/errno/getrlimit.c File Reference

#include <libexplain/buffer/errno/getrlimit.h>
#include <libexplain/getrlimit.h>

Go to the source code of this file.

Functions
void	explain_message_errno_getrlimit (char *message, int message_size, int errnum, int resource, struct rlimit *rlim)

---

Function Documentation

void explain_message_errno_getrlimit	(	char *	message,
		int	message_size,
		int	errnum,
		int	resource,
		struct rlimit *	rlim
	)

The explain_message_errno_getrlimit function is used to obtain an explanation of an error returned by the getrlimit(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.

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

 if (getrlimit(resource, rlim) < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_getrlimit(message, sizeof(message), err,
         resource, rlim);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_getrlimit_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
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.
resource	The original resource, exactly as passed to the getrlimit(2) system call.
rlim	The original rlim, exactly as passed to the getrlimit(2) system call.

Definition at line 24 of file getrlimit.c.