libexplain/getgrent_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/grp.h>
#include <libexplain/getgrent.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
struct group *	explain_getgrent_or_die (void)
struct group *	explain_getgrent_on_error (void)

---

Function Documentation

struct group* explain_getgrent_on_error

(

void

)

[read]

The explain_getgrent_on_error function is used to call the getgrent(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_getgrent(3) function.

Returns:

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

Example:

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

 errno = 0;
 struct group *result = explain_getgrent_on_error();
 if (!result && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 54 of file getgrent_or_die.c.

struct group* explain_getgrent_or_die

(

void

)

[read]

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

Returns:

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

 struct group *result = explain_getgrent_or_die();

Definition at line 27 of file getgrent_or_die.c.