explain_stat_or_die(3)

get file status and report errors

Section 3 libexplain-dev bookworm source

Description

explain_stat_or_die

NAME

explain_stat_or_die - get file status and report errors

SYNOPSIS

#include <libexplain/stat.h>
void explain_stat_or_die(const char *pathname, struct stat *buf);

DESCRIPTION

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

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

explain_stat_or_die(pathname, buf);

pathname

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

buf

The buf, exactly as to be passed to the stat(2) system call.

Returns:

This function only returns on success. On failure, prints an explanation and exits.