libexplain/realloc_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdlib.h>
#include <libexplain/realloc.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void *	explain_realloc_on_error (void *ptr, size_t size)

---

Function Documentation

void* explain_realloc_on_error	(	void *	ptr,
		size_t	size
	)

The explain_realloc_on_error function is used to call the realloc(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_realloc(3) function.

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

 void *new_ptr = explain_realloc_on_error(ptr, size);
 if (!new_ptr)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

ptr	The ptr, exactly as to be passed to the realloc(3) system call.
size	The size, exactly as to be passed to the realloc(3) system call.

Returns:

The value returned by the wrapped realloc(3) system call.

Definition at line 27 of file realloc_on_error.c.