1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
.\"
.\" libexplain - Explain errno values returned by libc functions
.\" Copyright (C) 2010, 2011 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 3 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License along
.\" with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.ds n) explain_vsnprintf_or_die
.cp 0 \" Solaris defaults to ''.cp 1'', sheesh.
.TH explain_vsnprintf_or_die 3
.SH NAME
explain_vsnprintf_or_die \- formatted output conversion and report errors
.if require_index \{
.XX "explain_vsnprintf_or_die(3)" \
"formatted output conversion and report errors"
.\}
.SH SYNOPSIS
#include <libexplain/vsnprintf.h>
.sp 0.3
int explain_vsnprintf_or_die(char *data, size_t data_size, const char
*format, va_list ap);
.br
int explain_vsnprintf_on_error(char *data, size_t data_size, const char
*format, va_list ap);
.SH DESCRIPTION
The \f[B]explain_vsnprintf_or_die\fP function is used to call the
\f[I]vsnprintf\fP(3) system call. On failure an explanation will be printed
to \f[I]stderr\fP, obtained from the \f[I]explain_vsnprintf\fP(3) function,
and then the process terminates by calling \f[CW]exit(EXIT_FAILURE)\fP.
.PP
The \f[B]explain_vsnprintf_on_error\fP function is used to call the
\f[I]vsnprintf\fP(3) system call. On failure an explanation will be printed
to \f[I]stderr\fP, obtained from the \f[I]explain_vsnprintf\fP(3) function,
but still returns to the caller.
.TP 8n
\f[I]data\fP
The data, exactly as to be passed to the \f[I]vsnprintf\fP(3) system call.
.TP 8n
\f[I]data_size\fP
The data_size, exactly as to be passed to the \f[I]vsnprintf\fP(3) system
call.
.TP 8n
\f[I]format\fP
The format, exactly as to be passed to the \f[I]vsnprintf\fP(3) system
call.
.TP 8n
\f[I]ap\fP
The ap, exactly as to be passed to the \f[I]vsnprintf\fP(3) system call.
.\" ----------------------------------------------------
.SH RETURN VALUE
The \f[B]explain_vsnprintf_or_die\fP function only returns on success, see
\f[I]vsnprintf\fP(3) for more information. On failure, prints an
explanation and exits, it does not return.
.PP
The \f[B]explain_vsnprintf_on_error\fP function always returns the value
return by the wrapped \f[I]vsnprintf\fP(3) system call.
.\" ----------------------------------------------------
.SH EXAMPLE
The \f[B]explain_vsnprintf_or_die\fP function is intended to be used in a
fashion similar to the following example:
.RS
.ft CW
.nf
int result = explain_vsnprintf_or_die(data, data_size, format, ap);
.fi
.ft R
.RE
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]vsnprintf\fP(3)
formatted output conversion
.TP 8n
\f[I]explain_vsnprintf\fP(3)
explain \f[I]vsnprintf\fP(3) errors
.TP 8n
\f[I]exit\fP(2)
terminate the calling process
.\" ----------------------------------------------------
.SH COPYRIGHT
.so etc/version.so
.if n .ds C) (C)
.if t .ds C) \(co
libexplain version \*(v)
.br
Copyright \*(C) 2010 Peter Miller
.\" vim: set ts=8 sw=4 et
|
