explain_getgrent_or_die(3)

get group file entry and report errors

Section 3 libexplain-dev bookworm source

Description

explain_getgrent_or_die

NAME

explain_getgrent_or_die - get group file entry and report errors

SYNOPSIS

#include <libexplain/getgrent.h>
struct group *explain_getgrent_or_die(void);
struct group *explain_getgrent_on_error(void);

DESCRIPTION

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

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

RETURN VALUE

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

The explain_getgrent_on_error function always returns the value return by the wrapped getgrent(3) system call.

EXAMPLE

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

struct group *result = explain_getgrent_or_die();