explain_openat_or_die(3)

open a file relative to a dir fd and report errors

Section 3 libexplain-dev bookworm source

Description

explain_openat_or_die

NAME

explain_openat_or_die - open a file relative to a dir fd and report errors

SYNOPSIS

#include <libexplain/openat.h>
int explain_openat_or_die(int fildes, const char *pathname, int flags, mode_t mode);
int explain_openat_on_error(int fildes, const char *pathname, int flags, mode_t mode);

DESCRIPTION

The explain_openat_or_die function is used to call the openat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_openat(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

The explain_openat_on_error function is used to call the openat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_openat(3) function, but still returns to the caller.

fildes

The fildes, exactly as to be passed to the openat(2) system call.

pathname

The pathname, exactly as to be passed to the openat(2) system call.

	flags		The flags, exactly as to be passed to the openat(2) system call.
	mode		The mode, exactly as to be passed to the openat(2) system call.

RETURN VALUE

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

The explain_openat_on_error function always returns the value return by the wrapped openat(2) system call.

EXAMPLE

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

int result = explain_openat_or_die(fildes, pathname, flags, mode);