libexplain/setgrent_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setgrent_or_die (void)
void	explain_setgrent_on_error (void)

---

Function Documentation

void explain_setgrent_on_error

(

void

)

The explain_setgrent_on_error function is used to call the setgrent(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_setgrent(3) function.

Returns:

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

Example:

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

 errno = 0;
 void result = explain_setgrent_on_error();
 if (result < 0 && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 44 of file setgrent_or_die.c.

void explain_setgrent_or_die

(

void

)

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

Returns:

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

 explain_setgrent_or_die();

Definition at line 27 of file setgrent_or_die.c.