libexplain/uname_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/utsname.h>
#include <libexplain/output.h>
#include <libexplain/uname.h>

Go to the source code of this file.

Functions
void	explain_uname_or_die (struct utsname *data)
int	explain_uname_on_error (struct utsname *data)

---

Function Documentation

int explain_uname_on_error

(

struct utsname *

data

)

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

Parameters:

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

Returns:

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

Example:

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

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

Definition at line 37 of file uname_or_die.c.

void explain_uname_or_die

(

struct utsname *

data

)

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

Parameters:

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

Returns:

This function only returns on success, see uname(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_uname_or_die(data);

Definition at line 27 of file uname_or_die.c.