---
name: "explain_strtol_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_strtol_or_die"
---

# explain\_strtol\_or\_die(3)

convert a string to a long integer and report errors

## NAME

explain\_strtol\_or\_die - convert a string to a long integer and report errors

## SYNOPSIS

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

long explain\_strtol\_or\_die(const char \*nptr, char \*\*endptr, int base);\
 long explain\_strtol\_on\_error(const char \*nptr, char \*\*endptr, int base))

## DESCRIPTION

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

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

- *nptr*

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

- *endptr*

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

- *base*

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

## RETURN VALUE

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

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

## EXAMPLE

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

```
long result = explain_strtol_or_die(nptr, endptr, base);
```

## SEE ALSO

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

  convert a string to a long integer

- [*explain\_strtol*(3)](/explain_strtol/3.md)

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

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

  terminate the calling process

## COPYRIGHT

libexplain version 1.4\
 Copyright (C) 2009 Peter Miller