explain_futimesat_or_die(3)

explain_futimesat_or_die3

Change timestamps of a file relative to a directory and report errors

Usage

#include <libexplain/futimesat.h>

void explain_futimesat_or_die(int fildes, const char *pathname, const struct timeval *data);
int explain_futimesat_on_error(int fildes, const char *pathname, const struct timeval *data);

Overview

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

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

fildes

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

pathname

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

data

The data, exactly as to be passed to the futimesat(2) system call.

Return value

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

The explain_futimesat_on_error function always returns the value return by the wrapped futimesat(2) system call.

Examples

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

explain_futimesat_or_die(fildes, pathname, data);

Releases

Unchanged in 5 releases since Debian 9 (Stretch).

  1. 9–13

From libexplain-dev 1.4.D001-16 in Debian 13 (Trixie). Parsed by carta from the page's man source.