.lf 1 ./man/man3/explain_iconv_or_die.3
.\"
.\" libexplain - Explain errno values returned by libc functions
.\" Copyright (C) 2013 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_iconv_or_die
.TH explain_iconv_or_die 3
.SH NAME
explain_iconv_or_die \- perform character set conversion and report errors
.if require_index \{
    "perform character set conversion and report errors"
.\}
.SH SYNOPSIS
#include <libexplain/iconv.h>
.sp 0.3
size_t explain_iconv_or_die(iconv_t cd, char **inbuf, size_t *inbytesleft,
char **outbuf, size_t *outbytesleft);
.br
size_t explain_iconv_on_error(iconv_t cd, char **inbuf, size_t
*inbytesleft, char **outbuf, size_t *outbytesleft);
.SH DESCRIPTION
The \f[B]explain_iconv_or_die\fP function is used to call the
\f[I]iconv\fP(3) system call. On failure an explanation will be printed to
\f[I]stderr\fP, obtained from the \f[I]explain_iconv\fP(3) function, and
then the process terminates by calling \f[CW]exit(EXIT_FAILURE)\fP.
.PP
The \f[B]explain_iconv_on_error\fP function is used to call the
\f[I]iconv\fP(3) system call. On failure an explanation will be printed to
\f[I]stderr\fP, obtained from the \f[I]explain_iconv\fP(3) function, but
still returns to the caller.
.TP 8n
\f[I]cd\fP
The cd, exactly as to be passed to the \f[I]iconv\fP(3) system call.
.TP 8n
\f[I]inbuf\fP
The inbuf, exactly as to be passed to the \f[I]iconv\fP(3) system call.
.TP 8n
\f[I]inbytesleft\fP
The inbytesleft, exactly as to be passed to the \f[I]iconv\fP(3) system
call.
.TP 8n
\f[I]outbuf\fP
The outbuf, exactly as to be passed to the \f[I]iconv\fP(3) system call.
.TP 8n
\f[I]outbytesleft\fP
The outbytesleft, exactly as to be passed to the \f[I]iconv\fP(3) system
call.
.\" ----------------------------------------------------
.SH RETURN VALUE
The \f[B]explain_iconv_or_die\fP function only returns on success, see
\f[I]iconv\fP(3) for more information. On failure, prints an explanation
and exits, it does not return.
.PP
The \f[B]explain_iconv_on_error\fP function always returns the value return
by the wrapped \f[I]iconv\fP(3) system call.
.\" ----------------------------------------------------
.SH EXAMPLE
The \f[B]explain_iconv_or_die\fP function is intended to be used in a
fashion similar to the following example:
.RS
.ft CW
.nf
size_t result = explain_iconv_or_die(cd, inbuf, inbytesleft, outbuf,
    outbytesleft);
.fi
.ft R
.RE
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]iconv\fP(3)
perform character set conversion
.TP 8n
\f[I]explain_iconv\fP(3)
explain \f[I]iconv\fP(3) errors
.TP 8n
\f[I]exit\fP(2)
terminate the calling process
.\" ----------------------------------------------------
.SH COPYRIGHT
.lf 1 ./etc/version.so
.ds v) 1.4
.ds V) 1.4.D001
.ds Y) 2008, 2009, 2010, 2011, 2012, 2013, 2014
.lf 95 ./man/man3/explain_iconv_or_die.3
.if n .ds C) (C)
.if t .ds C) \(co
libexplain version \*(v)
.br
Copyright \*(C) 2013 Peter Miller
.\" vim: set ts=8 sw=4 et :