libexplain/getdomainname_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/getdomainname.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_getdomainname_on_error (char *data, size_t data_size)
void	explain_getdomainname_or_die (char *data, size_t data_size)

---

Function Documentation

int explain_getdomainname_on_error	(	char *	data,
		size_t	data_size
	)

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

Parameters:

data	The data, exactly as to be passed to the getdomainname(2) system call.
data_size	The data_size, exactly as to be passed to the getdomainname(2) system call.

Returns:

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

Example:

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

 if (explain_getdomainname_on_error(data, data_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file getdomainname_or_die.c.

void explain_getdomainname_or_die	(	char *	data,
		size_t	data_size
	)

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

Parameters:

data	The data, exactly as to be passed to the getdomainname(2) system call.
data_size	The data_size, exactly as to be passed to the getdomainname(2) system call.

Returns:

This function only returns on success, see getdomainname(2) 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:

 explain_getdomainname_or_die(data, data_size);

Definition at line 51 of file getdomainname_or_die.c.