libexplain/asprintf_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdarg.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/asprintf.h>
#include <libexplain/buffer/errno/asprintf.h>
#include <libexplain/common_message_buffer.h>
#include <libexplain/output.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
int	explain_asprintf_or_die (char **data, const char *format,...)
int	explain_asprintf_on_error (char **data, const char *format,...)

---

Function Documentation

int explain_asprintf_on_error	(	char **	data,
		const char *	format,
			...
	)

The explain_asprintf_on_error function is used to call the asprintf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_asprintf(3) function.

Parameters:

data	The data argument exactly as it was passed to asprintf
format	The format argument exactly as it was passed to asprintf

Returns:

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

Example:

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

 errno = 0;
 int result = explain_asprintf_on_error();
 if (result < 0 || errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 76 of file asprintf_or_die.c.

int explain_asprintf_or_die	(	char **	data,
		const char *	format,
			...
	)

The explain_asprintf_or_die function is used to call the asprintf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_asprintf(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

data	The data argument exactly as it was passed to asprintf
format	The format argument exactly as it was passed to asprintf

Returns:

This function only returns on success, see asprintf(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 int result = explain_asprintf_or_die();

Definition at line 31 of file asprintf_or_die.c.