master
 1/* Copyright (C) 1997-2025 Free Software Foundation, Inc.
 2   This file is part of the GNU C Library.
 3
 4   The GNU C Library is free software; you can redistribute it and/or
 5   modify it under the terms of the GNU Lesser General Public
 6   License as published by the Free Software Foundation; either
 7   version 2.1 of the License, or (at your option) any later version.
 8
 9   The GNU C Library is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   Lesser General Public License for more details.
13
14   You should have received a copy of the GNU Lesser General Public
15   License along with the GNU C Library; if not, see
16   <https://www.gnu.org/licenses/>.  */
17
18#ifndef _ICONV_H
19#define _ICONV_H	1
20
21#include <features.h>
22#define __need_size_t
23#include <stddef.h>
24
25
26__BEGIN_DECLS
27
28/* Identifier for conversion method from one codeset to another.  */
29typedef void *iconv_t;
30
31
32/* Free resources allocated for descriptor CD for code conversion.
33
34   This function is a possible cancellation point and therefore not
35   marked with __THROW.  */
36extern int iconv_close (iconv_t __cd);
37
38/* Allocate descriptor for code conversion from codeset FROMCODE to
39   codeset TOCODE.
40
41   This function is a possible cancellation point and therefore not
42   marked with __THROW.  */
43extern iconv_t iconv_open (const char *__tocode, const char *__fromcode)
44	__attribute_malloc__ __attr_dealloc (iconv_close, 1);
45
46/* Convert at most *INBYTESLEFT bytes from *INBUF according to the
47   code conversion algorithm specified by CD and place up to
48   *OUTBYTESLEFT bytes in buffer at *OUTBUF.  */
49extern size_t iconv (iconv_t __cd, char **__restrict __inbuf,
50		     size_t *__restrict __inbytesleft,
51		     char **__restrict __outbuf,
52		     size_t *__restrict __outbytesleft);
53
54__END_DECLS
55
56#endif /* iconv.h */