original/man3/iconv_close.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   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 2 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  2008-08-11 "GNU" "Linux Programmer's Manual"
  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
  23 .BR iconv_close ()
  24 function deallocates a conversion descriptor \fIcd\fP
  25 previously allocated using
  26 .BR iconv_open (3).
  27 .SH "RETURN VALUE"
  28 When successful, the
  29 .BR iconv_close ()
  30 function returns 0.
  31 In case of error, it sets
  32 .I errno
  33 and returns \-1.
  34 .SH VERSIONS
  35 This function is available in glibc since version 2.1.
  36 .SH "CONFORMING TO"
  37 UNIX98, POSIX.1-2001.
  38 .SH "SEE ALSO"
  39 .BR iconv (3),
  40 .BR iconv_open (3)