---
name: "explain_linkat_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_linkat_or_die"
---

# explain\_linkat\_or\_die(3)

link a file relative to directory and report errors

## NAME

explain\_linkat\_or\_die - link a file relative to directory and report errors

## SYNOPSIS

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

void explain\_linkat\_or\_die(int old\_dirfd, const char \*old\_path, int new\_fildes, const char \*new\_path, int flags);\
 int explain\_linkat\_on\_error(int old\_dirfd, const char \*old\_path, int new\_fildes, const char \*new\_path, int flags);

## DESCRIPTION

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

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

- *old\_dirfd*

  The old\_dirfd, exactly as to be passed to the [*linkat*(2)](/linkat/2.md) system call.

- *old\_path*

  The old\_path, exactly as to be passed to the [*linkat*(2)](/linkat/2.md) system call.

- *new\_fildes*

  The new\_fildes, exactly as to be passed to the [*linkat*(2)](/linkat/2.md) system call.

- *new\_path*

  The new\_path, exactly as to be passed to the [*linkat*(2)](/linkat/2.md) system call.

- *flags*

  The flags, exactly as to be passed to the [*linkat*(2)](/linkat/2.md) system call.

## RETURN VALUE

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

The **explain\_linkat\_on\_error** function always returns the value return by the wrapped [*linkat*(2)](/linkat/2.md) system call.

## EXAMPLE

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

```
explain_linkat_or_die(old_dirfd, old_path, new_fildes, new_path, flags);
```

## SEE ALSO

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

  create a file link relative to directory file descriptors

- [*explain\_linkat*(3)](/explain_linkat/3.md)

  explain [*linkat*(2)](/linkat/2.md) errors

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

  terminate the calling process

## COPYRIGHT

libexplain version 1.4\
 Copyright (C) 2013 Peter Miller