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  2021-03-22 "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 On success,
  32 .BR iconv_close ()
  33 returns 0; otherwise, it returns \-1 and sets
  34 .I errno
  35 to indicate the error.
  36 .SH VERSIONS
  37 This function is available in glibc since version 2.1.
  38 .SH ATTRIBUTES
  39 For an explanation of the terms used in this section, see
  40 .BR attributes (7).
  41 .ad l
  42 .nh
  43 .TS
  44 allbox;
  45 lbx lb lb
  46 l l l.
  47 Interface       Attribute       Value
  48 T{
  49 .BR iconv_close ()
  50 T}      Thread safety   MT-Safe
  51 .TE
  52 .hy
  53 .ad
  54 .sp 1
  55 .SH CONFORMING TO
  56 POSIX.1-2001, POSIX.1-2008, SUSv2.
  57 .SH SEE ALSO
  58 .BR iconv (3),
  59 .BR iconv_open (3)