original/man3/iconv_close.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  13 .\"
  14 .TH ICONV_CLOSE 3  2008-08-11 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 iconv_close \- deallocate descriptor for character set conversion
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <iconv.h>
  20 .sp
  21 .BI "int iconv_close(iconv_t " cd );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR iconv_close ()
  26 function deallocates a conversion descriptor
  27 .I cd
  28 previously allocated using
  29 .BR iconv_open (3).
  30 .SH RETURN VALUE
  31 When successful, the
  32 .BR iconv_close ()
  33 function returns 0.
  34 In case of error, it sets
  35 .I errno
  36 and returns \-1.
  37 .SH VERSIONS
  38 This function is available in glibc since version 2.1.
  39 .SH CONFORMING TO
  40 UNIX98, POSIX.1-2001.
  41 .SH SEE ALSO
  42 .BR iconv (3),
  43 .BR iconv_open (3)
  44 .SH COLOPHON
  45 This page is part of release 3.78 of the Linux
  46 .I man-pages
  47 project.
  48 A description of the project,
  49 information about reporting bugs,
  50 and the latest version of this page,
  51 can be found at
  52 \%http://www.kernel.org/doc/man\-pages/.