explain_vsprintf_or_die(3)

explain_vsprintf_or_die3

Formatted output conversion and report errors

Usage

#include <libexplain/vsprintf.h>

int explain_vsprintf_or_die(char *data, const char *format, va_list ap);
int explain_vsprintf_on_error(char *data, const char *format, va_list ap);

Overview

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

The explain_vsprintf_on_error function is used to call the vsprintf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_vsprintf(3) function, but still returns to the caller.

data

The data, exactly as to be passed to the vsprintf(3) system call.

format

The format, exactly as to be passed to the vsprintf(3) system call.

ap

The ap, exactly as to be passed to the vsprintf(3) system call.

Return value

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

The explain_vsprintf_on_error function always returns the value return by the wrapped vsprintf(3) system call.

Examples

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

int result = explain_vsprintf_or_die(data, format, ap);

Releases

6 releases since Debian 7 (Wheezy); the text changed 1 time.

  1. 7
  2. 9–13

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