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  2017-09-15 "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 .PP
  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 ATTRIBUTES
  40 For an explanation of the terms used in this section, see
  41 .BR attributes (7).
  42 .TS
  43 allbox;
  44 lb lb lb
  45 l l l.
  46 Interface       Attribute       Value
  47 T{
  48 .BR iconv_close ()
  49 T}      Thread safety   MT-Safe
  50 .TE
  51 .sp 1
  52 .SH CONFORMING TO
  53 POSIX.1-2001, POSIX.1-2008, SUSv2.
  54 .SH SEE ALSO
  55 .BR iconv (3),
  56 .BR iconv_open (3)