---
name: "explain_iconv_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_iconv_or_die"
---

# explain\_iconv\_or\_die(3)

perform character set conversion and report errors

## NAME

explain\_iconv\_or\_die - perform character set conversion and report errors

## SYNOPSIS

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

size\_t explain\_iconv\_or\_die(iconv\_t cd, char \*\*inbuf, size\_t \*inbytesleft, char \*\*outbuf, size\_t \*outbytesleft);\
 size\_t explain\_iconv\_on\_error(iconv\_t cd, char \*\*inbuf, size\_t \*inbytesleft, char \*\*outbuf, size\_t \*outbytesleft);

## DESCRIPTION

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

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

- *cd*

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

- *inbuf*

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

- *inbytesleft*

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

- *outbuf*

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

- *outbytesleft*

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

## RETURN VALUE

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

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

## EXAMPLE

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

```
size_t result = explain_iconv_or_die(cd, inbuf, inbytesleft, outbuf,
    outbytesleft);
```

## SEE ALSO

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

  perform character set conversion

- [*explain\_iconv*(3)](/explain_iconv/3.md)

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

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

  terminate the calling process

## COPYRIGHT

libexplain version 1.4\
 Copyright (C) 2013 Peter Miller