man3/iconv_close.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" SPDX-License-Identifier: GPL-2.0-or-later
   4 .\"
   5 .\" References consulted:
   6 .\"   GNU glibc-2 source code and manual
   7 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
   8 .\"
   9 .TH ICONV_CLOSE 3  2021-03-22 "Linux man-pages (unreleased)"
  10 .SH NAME
  11 iconv_close \- deallocate descriptor for character set conversion
  12 .SH LIBRARY
  13 Standard C library
  14 .RI ( libc ", " \-lc )
  15 .SH SYNOPSIS
  16 .nf
  17 .B #include <iconv.h>
  18 .PP
  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
  25 .I cd
  26 previously allocated using
  27 .BR iconv_open (3).
  28 .SH RETURN VALUE
  29 On success,
  30 .BR iconv_close ()
  31 returns 0; otherwise, it returns \-1 and sets
  32 .I errno
  33 to indicate the error.
  34 .SH VERSIONS
  35 This function is available in glibc since version 2.1.
  36 .SH ATTRIBUTES
  37 For an explanation of the terms used in this section, see
  38 .BR attributes (7).
  39 .ad l
  40 .nh
  41 .TS
  42 allbox;
  43 lbx lb lb
  44 l l l.
  45 Interface       Attribute       Value
  46 T{
  47 .BR iconv_close ()
  48 T}      Thread safety   MT-Safe
  49 .TE
  50 .hy
  51 .ad
  52 .sp 1
  53 .SH STANDARDS
  54 POSIX.1-2001, POSIX.1-2008, SUSv2.
  55 .SH SEE ALSO
  56 .BR iconv (3),
  57 .BR iconv_open (3)