libexplain/sethostname_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_sethostname_on_error (const char *name, size_t name_size)

---

Function Documentation

int explain_sethostname_on_error	(	const char *	name,
		size_t	name_size
	)

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

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

 if (explain_sethostname_on_error(name, name_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

name	The name, exactly as to be passed to the sethostname(2) system call.
name_size	The name_size, exactly as to be passed to the sethostname(2) system call.

Returns:

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

Definition at line 27 of file sethostname_on_error.c.