Update after gnulib changed.
[libiconv.git] / man / iconv_close.3
blob28ea58e1405e1bdd486780c20969898800516402
1 .\" Copyright (c) Free Software Foundation, Inc.
2 .\"
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 3 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" References consulted:
9 .\"   GNU glibc-2 source code and manual
10 .\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
11 .\"
12 .TH ICONV_CLOSE 3  "March 31, 2007" "GNU"
13 .SH NAME
14 iconv_close \- deallocate descriptor for character set conversion
15 .SH SYNOPSIS
16 .nf
17 .B #include <iconv.h>
18 .sp
19 .BI "int iconv_close (iconv_t " cd );
20 .fi
21 .SH DESCRIPTION
22 The \fBiconv_close\fP function deallocates a conversion descriptor \fIcd\fP
23 previously allocated using \fBiconv_open\fP.
24 .SH "RETURN VALUE"
25 When successful, the \fBiconv_close\fP function returns 0. In case of error,
26 it sets \fBerrno\fP and returns \-1.
27 .SH "CONFORMING TO"
28 POSIX:2001
29 .SH "SEE ALSO"
30 .BR iconv_open (3)
31 .BR iconv (3)