1explain_sprintf_or_die(3)  Library Functions Manual  explain_sprintf_or_die(3)
2
3
4

NAME

6       explain_sprintf_or_die - formatted output conversion and report errors
7

SYNOPSIS

9       #include <libexplain/sprintf.h>
10       int explain_sprintf_or_die(char *data, const char *format, ...);
11       int explain_sprintf_on_error(char *data, const char *format, ...);
12

DESCRIPTION

14       The explain_sprintf_or_die function is used to call the sprintf(3) sys‐
15       tem call. On failure an explanation will be printed to stderr, obtained
16       from  the  explain_sprintf(3) function, and then the process terminates
17       by calling exit(EXIT_FAILURE).
18
19       The explain_sprintf_on_error function is used to  call  the  sprintf(3)
20       system  call.  On  failure  an  explanation  will be printed to stderr,
21       obtained from the explain_sprintf(3) function, but still returns to the
22       caller.
23
24       data    The  data,  exactly  as  to  be passed to the sprintf(3) system
25               call.
26
27       format  The format, exactly as to be passed to  the  sprintf(3)  system
28               call.
29

RETURN VALUE

31       The  explain_sprintf_or_die  function  only  returns  on  success,  see
32       sprintf(3) for more information. On failure, prints an explanation  and
33       exits, it does not return.
34
35       The  explain_sprintf_on_error  function always returns the value return
36       by the wrapped sprintf(3) system call.
37

EXAMPLE

39       The explain_sprintf_or_die function is intended to be used in a fashion
40       similar to the following example:
41              int result = explain_sprintf_or_die(data, format, ...);
42

SEE ALSO

44       sprintf(3)
45               formatted output conversion
46
47       explain_sprintf(3)
48               explain sprintf(3) errors
49
50       exit(2) terminate the calling process
51

53       libexplain version 1.4
54       Copyright (C) 2010 Peter Miller
55
56
57
58                                                     explain_sprintf_or_die(3)
Impressum