explain_setgrent_or_die(3)

rewind group database and report errors

Section 3 libexplain-dev bookworm source

Description

explain_setgrent_or_die

NAME

explain_setgrent_or_die - rewind group database and report errors

SYNOPSIS

#include <libexplain/setgrent.h>
void explain_setgrent_or_die(void);
void explain_setgrent_on_error(void);

DESCRIPTION

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).

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, but still returns to the caller.

RETURN VALUE

The explain_setgrent_or_die function only returns on success, see setgrent(3) for more information. On failure, prints an explanation and exits, it does not return.

The explain_setgrent_on_error function always returns the value return by the wrapped setgrent(3) system call.

EXAMPLE

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

explain_setgrent_or_die();