man3/iconv_close.3

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