---
name: "explain_getgrouplist_or_die"
section: "3"
platform: "linux"
package: "libexplain-dev"
version: "1.4.D001-16"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/explain_getgrouplist_or_die"
---

# explain\_getgrouplist\_or\_die(3)

get list of groups and report errors

## NAME

explain\_getgrouplist\_or\_die - get list of groups and report errors

## SYNOPSIS

\#include \<libexplain/getgrouplist.h\>

void explain\_getgrouplist\_or\_die(const char \*user, gid\_t group, gid\_t \*groups, int \*ngroups);\
 int explain\_getgrouplist\_on\_error(const char \*user, gid\_t group, gid\_t \*groups, int \*ngroups);

## DESCRIPTION

The **explain\_getgrouplist\_or\_die** function is used to call the [*getgrouplist*(3)](/getgrouplist/3.md) system call. On failure an explanation will be printed to *stderr*, obtained from the [*explain\_getgrouplist*(3)](/explain_getgrouplist/3.md) function, and then the process terminates by calling `exit(EXIT_FAILURE)`.

The **explain\_getgrouplist\_on\_error** function is used to call the [*getgrouplist*(3)](/getgrouplist/3.md) system call. On failure an explanation will be printed to *stderr*, obtained from the [*explain\_getgrouplist*(3)](/explain_getgrouplist/3.md) function, but still returns to the caller.

- *user*

  The user, exactly as to be passed to the [*getgrouplist*(3)](/getgrouplist/3.md) system call.

- *group*

  The group, exactly as to be passed to the [*getgrouplist*(3)](/getgrouplist/3.md) system call.

- *groups*

  The groups, exactly as to be passed to the [*getgrouplist*(3)](/getgrouplist/3.md) system call.

- *ngroups*

  The ngroups, exactly as to be passed to the [*getgrouplist*(3)](/getgrouplist/3.md) system call.

## RETURN VALUE

The **explain\_getgrouplist\_or\_die** function only returns on success, see [*getgrouplist*(3)](/getgrouplist/3.md) for more information. On failure, prints an explanation and exits, it does not return.

The **explain\_getgrouplist\_on\_error** function always returns the value return by the wrapped [*getgrouplist*(3)](/getgrouplist/3.md) system call.

## EXAMPLE

The **explain\_getgrouplist\_or\_die** function is intended to be used in a fashion similar to the following example:

```
explain_getgrouplist_or_die(user, group, groups, ngroups);
```

## SEE ALSO

- [*getgrouplist*(3)](/getgrouplist/3.md)

  get list of groups to which a user belongs

- [*explain\_getgrouplist*(3)](/explain_getgrouplist/3.md)

  explain [*getgrouplist*(3)](/getgrouplist/3.md) errors

- [*exit*(2)](/exit/2.md)

  terminate the calling process

## COPYRIGHT

libexplain version 1.4\
 Copyright (C) 2013 Peter Miller